@digitraffic/common 2023.4.3-1 → 2023.4.28-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/README.md +1 -1
  2. package/dist/aws/infra/api/response.d.ts +2 -1
  3. package/dist/aws/infra/api/response.js +6 -2
  4. package/dist/aws/types/lambda-response.d.ts +5 -1
  5. package/dist/aws/types/lambda-response.js +16 -12
  6. package/dist/types/nullable.d.ts +24 -0
  7. package/dist/types/nullable.js +3 -0
  8. package/dist/types/util-types.d.ts +1 -0
  9. package/dist/types/util-types.js +3 -0
  10. package/package.json +30 -29
  11. package/src/aws/infra/api/response.ts +6 -2
  12. package/src/aws/types/lambda-response.ts +38 -22
  13. package/src/types/nullable.ts +21 -0
  14. package/src/types/util-types.ts +1 -0
package/README.md CHANGED
@@ -15,7 +15,7 @@ In package.json dependencies:
15
15
  In code:
16
16
 
17
17
  ```
18
- import {DigitrafficStack, StackConfiguration} from "@digitraffic/common/aws/infra/stack/stack";
18
+ import {DigitrafficStack, StackConfiguration} from "@digitraffic/common/dist/aws/infra/stack/stack";
19
19
  ```
20
20
 
21
21
  ### DigitrafficStack
package/dist/aws/infra/api/response.d.ts CHANGED
@@ -10,8 +10,9 @@ import { IModel } from "aws-cdk-lib/aws-apigateway/lib/model";
10
10
  * non-textual content.
11
11
  *
12
12
  * If fileName is set, then Content-Disposition-header will be set to use it
13
+ * If timestamp is set, then ETag & Last-Modified headers will be set
13
14
  */
14
- 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";
15
+ export declare const RESPONSE_DEFAULT_LAMBDA = "#set($inputRoot = $input.path('$'))\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.timestamp\" != \"\")\n#set ($context.responseOverride.header.ETag = $inputRoot.timestamp)\n#set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)\n#end\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$util.base64Decode($inputRoot.body)";
15
16
  /**
16
17
  * Use this for deprecated integrations.
17
18
  * Will add HTTP headers Deprecation and Sunset to response.
package/dist/aws/infra/api/response.js CHANGED
@@ -13,19 +13,23 @@ const date_utils_1 = require("../../../utils/date-utils");
13
13
  * non-textual content.
14
14
  *
15
15
  * If fileName is set, then Content-Disposition-header will be set to use it
16
+ * If timestamp is set, then ETag & Last-Modified headers will be set
16
17
  */
17
18
  exports.RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
18
- $util.base64Decode($inputRoot.body)
19
19
  #if ($inputRoot.status != 200)
20
20
  #set ($context.responseOverride.status = $inputRoot.status)
21
21
  #set ($context.responseOverride.header.Content-Type = 'text/plain')
22
22
  #end
23
23
  #set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')
24
+ #if ("$!inputRoot.timestamp" != "")
25
+ #set ($context.responseOverride.header.ETag = $inputRoot.timestamp)
26
+ #set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)
27
+ #end
24
28
  #if ("$!inputRoot.fileName" != "")
25
29
  #set ($disposition = 'attachment; filename="FN"')
26
30
  #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))
27
31
  #end
28
- `;
32
+ $util.base64Decode($inputRoot.body)`;
29
33
  /**
30
34
  * Use this for deprecated integrations.
31
35
  * Will add HTTP headers Deprecation and Sunset to response.
package/dist/aws/types/lambda-response.d.ts CHANGED
@@ -2,7 +2,9 @@ export declare class LambdaResponse {
2
2
  readonly status: number;
3
3
  readonly body: string;
4
4
  readonly fileName?: string;
5
- constructor(status: number, body: string, fileName?: string);
5
+ readonly timestamp?: string;
6
+ constructor(status: number, body: string, fileName?: string, timestamp?: Date);
7
+ withTimestamp(timestamp: Date): LambdaResponse;
6
8
  /**
7
9
  * Create LambdaResponse for HTTP 200 from json.
8
10
  */
@@ -31,4 +33,6 @@ export declare class LambdaResponse {
31
33
  * Create LambdaResponse for HTTP 501
32
34
  */
33
35
  static notImplemented(): LambdaResponse;
36
+ private static createForString;
37
+ private static createForBase64;
34
38
  }
package/dist/aws/types/lambda-response.js CHANGED
@@ -2,10 +2,14 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LambdaResponse = void 0;
4
4
  class LambdaResponse {
5
- constructor(status, body, fileName) {
5
+ constructor(status, body, fileName, timestamp) {
6
6
  this.status = status;
7
7
  this.body = body;
8
8
  this.fileName = fileName;
9
+ this.timestamp = timestamp?.toUTCString();
10
+ }
11
+ withTimestamp(timestamp) {
12
+ return new LambdaResponse(this.status, this.body, this.fileName, timestamp);
9
13
  }
10
14
  /**
11
15
  * Create LambdaResponse for HTTP 200 from json.
@@ -23,41 +27,41 @@ class LambdaResponse {
23
27
  * Create LambdaResponse for HTTP 200 from base64-encoded data.
24
28
  */
25
29
  static okBinary(base64, fileName) {
26
- return createForBase64(200, base64, fileName);
30
+ return this.createForBase64(200, base64, fileName);
27
31
  }
28
32
  /**
29
33
  * Create LambdaResponse for HTTP 400
30
34
  */
31
35
  static badRequest(body) {
32
- return createForString(400, body);
36
+ return this.createForString(400, body);
33
37
  }
34
38
  /**
35
39
  * Create LambdaResponse for HTTP 404
36
40
  */
37
41
  static notFound() {
38
- return createForString(404, "Not found");
42
+ return this.createForString(404, "Not found");
39
43
  }
40
44
  /**
41
45
  * Create LambdaResponse for HTTP 500
42
46
  */
43
47
  static internalError() {
44
- return createForString(500, "Internal error");
48
+ return this.createForString(500, "Internal error");
45
49
  }
46
50
  /**
47
51
  * Create LambdaResponse for HTTP 501
48
52
  */
49
53
  static notImplemented() {
50
- return createForString(501, "Not implemented");
54
+ return this.createForString(501, "Not implemented");
55
+ }
56
+ static createForString(status, body, fileName) {
57
+ return this.createForBase64(status, toBase64(body), fileName);
58
+ }
59
+ static createForBase64(status, base64Body, fileName) {
60
+ return new LambdaResponse(status, base64Body, fileName);
51
61
  }
52
62
  }
53
63
  exports.LambdaResponse = LambdaResponse;
54
64
  function toBase64(body) {
55
65
  return Buffer.from(body).toString("base64");
56
66
  }
57
- function createForString(status, body, fileName) {
58
- return createForBase64(status, toBase64(body), fileName);
59
- }
60
- function createForBase64(status, base64Body, fileName) {
61
- return new LambdaResponse(status, base64Body, fileName);
62
- }
63
67
  //# sourceMappingURL=lambda-response.js.map
package/dist/types/nullable.d.ts ADDED
@@ -0,0 +1,24 @@
1
+ import { ValueOf } from "./util-types";
2
+ /**
3
+ * Adds `null` as an accepted type to all properties in given type.
4
+ */
5
+ export type Nullable<Obj> = {
6
+ [Key in keyof Obj]: Obj[Key] | null;
7
+ };
8
+ type RequiredKeys<Obj> = ValueOf<{
9
+ [Key in keyof Obj]-?: object extends {
10
+ [K in Key]: Obj[Key];
11
+ } ? never : Key;
12
+ }>;
13
+ type OptionalKeys<Obj> = ValueOf<{
14
+ [Key in keyof Obj]-?: object extends {
15
+ [K in Key]: Obj[Key];
16
+ } ? Key : never;
17
+ }>;
18
+ type RequiredProperties<Obj> = Pick<Obj, RequiredKeys<Obj>>;
19
+ type OptionalProperties<Obj> = Pick<Obj, OptionalKeys<Obj>>;
20
+ /**
21
+ * Adds `null` as an accepted type to all optional properties in given type. Required properties remain unchanged.
22
+ */
23
+ export type NullableOptional<Obj> = RequiredProperties<Obj> & Nullable<OptionalProperties<Obj>>;
24
+ export {};
package/dist/types/nullable.js ADDED
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=nullable.js.map
package/dist/types/util-types.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type ValueOf<Obj> = Obj[keyof Obj];
package/dist/types/util-types.js ADDED
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=util-types.js.map
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@digitraffic/common",
3
- "version": "2023.4.3-1",
3
+ "version": "2023.4.28-1",
4
4
  "description": "",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "https://github.com/tmfg/digitraffic-common.git"
8
8
  },
9
9
  "engines": {
10
- "node": ">=14 <17"
10
+ "node": ">=14 <17 || >=18 <19"
11
11
  },
12
12
  "license": "EUPL-1.2",
13
13
  "private": false,
@@ -17,53 +17,54 @@
17
17
  "src/**/*.ts"
18
18
  ],
19
19
  "peerDependencies": {
20
- "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
20
+ "@aws-cdk/aws-synthetics-alpha": "^2.62.2-alpha.0",
21
21
  "@types/geojson": "^7946.0.10",
22
- "aws-cdk-lib": "2.70.0",
23
- "aws-sdk": "^2.1343.0",
24
- "axios": "^1.3.4",
22
+ "aws-cdk-lib": "^2.76.0",
23
+ "aws-sdk": "^2.1362.0",
24
+ "axios": "^1.2.6",
25
25
  "change-case": "^4.1.2",
26
26
  "constructs": "^10.1.292",
27
27
  "geojson-validation": "^1.0.2",
28
28
  "moment": "^2.29.4",
29
29
  "node-ttl": "^0.2.0",
30
30
  "pg-native": "^3.0.1",
31
- "pg-promise": "^10.12.0"
31
+ "pg-promise": "^11.0.0"
32
32
  },
33
33
  "devDependencies": {
34
34
  "@aws-cdk/aws-synthetics-alpha": "2.70.0-alpha.0",
35
- "@types/aws-lambda": "^8.10.114",
35
+ "@types/aws-lambda": "~8.10.114",
36
36
  "@types/geojson": "^7946.0.10",
37
- "@types/jest": "^29.5.0",
38
- "@types/lodash": "^4.14.192",
39
- "@types/node": "^18.15.10",
40
- "@types/ramda": "^0.28.23",
41
- "@types/sinon": "^10.0.13",
42
- "@typescript-eslint/eslint-plugin": "~5.56.0",
43
- "@typescript-eslint/parser": "^5.56.0",
44
- "aws-cdk-lib": "^2.70.0",
45
- "aws-sdk": "^2.1343.0",
46
- "axios": "^1.3.4",
37
+ "@types/jest": "^29.5.1",
38
+ "@types/lodash": "^4.14.194",
39
+ "@types/node": "18.15.13",
40
+ "@types/ramda": "~0.29.0",
41
+ "@types/sinon": "10.0.14",
42
+ "@typescript-eslint/eslint-plugin": "~5.59.0",
43
+ "@typescript-eslint/parser": "^5.59.0",
44
+ "aws-cdk-lib": "~2.76.0",
45
+ "aws-sdk": "~2.1362.0",
46
+ "axios": "^1.3.6",
47
47
  "change-case": "^4.1.2",
48
- "constructs": "^10.1.292",
49
- "eslint": "~8.36.0",
48
+ "constructs": "10.2.2",
49
+ "eslint": "~8.38.0",
50
50
  "eslint-config-prettier": "^8.8.0",
51
- "eslint-plugin-deprecation": "~1.3.3",
51
+ "eslint-plugin-deprecation": "~1.4.1",
52
52
  "geojson-validation": "^1.0.2",
53
53
  "husky": "^8.0.3",
54
54
  "jest": "^29.5.0",
55
- "jest-junit": "^15.0.0",
56
- "lint-staged": "^13.2.0",
55
+ "jest-junit": "^16.0.0",
56
+ "lint-staged": "^13.2.1",
57
57
  "moment": "^2.29.4",
58
58
  "node-ttl": "^0.2.0",
59
59
  "pg-native": "^3.0.1",
60
- "pg-promise": "^10.12.0",
60
+ "pg-promise": "^11.4.3",
61
61
  "prettier": "^2.8.7",
62
- "ramda": "^0.28.0",
63
- "rimraf": "^4.1.0",
64
- "sinon": "^15.0.3",
65
- "ts-jest": "^29.0.5",
66
- "typescript": "~4.9.5"
62
+ "ramda": "~0.29.0",
63
+ "rimraf": "^5.0.0",
64
+ "sinon": "15.0.4",
65
+ "ts-jest": "^29.1.0",
66
+ "typescript": "~4.9.5",
67
+ "velocityjs": "2.0.6"
67
68
  },
68
69
  "externals": [
69
70
  "aws-sdk",
package/src/aws/infra/api/response.ts CHANGED
@@ -18,19 +18,23 @@ import { dateFromIsoString } from "../../../utils/date-utils";
18
18
  * non-textual content.
19
19
  *
20
20
  * If fileName is set, then Content-Disposition-header will be set to use it
21
+ * If timestamp is set, then ETag & Last-Modified headers will be set
21
22
  */
22
23
  export const RESPONSE_DEFAULT_LAMBDA = `#set($inputRoot = $input.path('$'))
23
- $util.base64Decode($inputRoot.body)
24
24
  #if ($inputRoot.status != 200)
25
25
  #set ($context.responseOverride.status = $inputRoot.status)
26
26
  #set ($context.responseOverride.header.Content-Type = 'text/plain')
27
27
  #end
28
28
  #set ($context.responseOverride.header.Access-Control-Allow-Origin = '*')
29
+ #if ("$!inputRoot.timestamp" != "")
30
+ #set ($context.responseOverride.header.ETag = $inputRoot.timestamp)
31
+ #set ($context.responseOverride.header.Last-Modified = $inputRoot.timestamp)
32
+ #end
29
33
  #if ("$!inputRoot.fileName" != "")
30
34
  #set ($disposition = 'attachment; filename="FN"')
31
35
  #set ($context.responseOverride.header.Content-Disposition = $disposition.replaceAll('FN', $inputRoot.fileName))
32
36
  #end
33
- `;
37
+ $util.base64Decode($inputRoot.body)`;
34
38
 
35
39
  /**
36
40
  * Use this for deprecated integrations.
package/src/aws/types/lambda-response.ts CHANGED
@@ -2,11 +2,27 @@ export class LambdaResponse {
2
2
  readonly status: number;
3
3
  readonly body: string;
4
4
  readonly fileName?: string;
5
+ readonly timestamp?: string;
5
6
 
6
- constructor(status: number, body: string, fileName?: string) {
7
+ constructor(
8
+ status: number,
9
+ body: string,
10
+ fileName?: string,
11
+ timestamp?: Date
12
+ ) {
7
13
  this.status = status;
8
14
  this.body = body;
9
15
  this.fileName = fileName;
16
+ this.timestamp = timestamp?.toUTCString();
17
+ }
18
+
19
+ withTimestamp(timestamp: Date) {
20
+ return new LambdaResponse(
21
+ this.status,
22
+ this.body,
23
+ this.fileName,
24
+ timestamp
25
+ );
10
26
  }
11
27
 
12
28
  /**
@@ -27,54 +43,54 @@ export class LambdaResponse {
27
43
  * Create LambdaResponse for HTTP 200 from base64-encoded data.
28
44
  */
29
45
  static okBinary(base64: string, fileName?: string) {
30
- return createForBase64(200, base64, fileName);
46
+ return this.createForBase64(200, base64, fileName);
31
47
  }
32
48
 
33
49
  /**
34
50
  * Create LambdaResponse for HTTP 400
35
51
  */
36
52
  static badRequest(body: string) {
37
- return createForString(400, body);
53
+ return this.createForString(400, body);
38
54
  }
39
55
 
40
56
  /**
41
57
  * Create LambdaResponse for HTTP 404
42
58
  */
43
59
  static notFound() {
44
- return createForString(404, "Not found");
60
+ return this.createForString(404, "Not found");
45
61
  }
46
62
 
47
63
  /**
48
64
  * Create LambdaResponse for HTTP 500
49
65
  */
50
66
  static internalError() {
51
- return createForString(500, "Internal error");
67
+ return this.createForString(500, "Internal error");
52
68
  }
53
69
 
54
70
  /**
55
71
  * Create LambdaResponse for HTTP 501
56
72
  */
57
73
  static notImplemented() {
58
- return createForString(501, "Not implemented");
74
+ return this.createForString(501, "Not implemented");
59
75
  }
60
- }
61
76
 
62
- function toBase64(body: string) {
63
- return Buffer.from(body).toString("base64");
64
- }
77
+ private static createForString(
78
+ status: number,
79
+ body: string,
80
+ fileName?: string
81
+ ): LambdaResponse {
82
+ return this.createForBase64(status, toBase64(body), fileName);
83
+ }
65
84
 
66
- function createForString(
67
- status: number,
68
- body: string,
69
- fileName?: string
70
- ): LambdaResponse {
71
- return createForBase64(status, toBase64(body), fileName);
85
+ private static createForBase64(
86
+ status: number,
87
+ base64Body: string,
88
+ fileName?: string
89
+ ): LambdaResponse {
90
+ return new LambdaResponse(status, base64Body, fileName);
91
+ }
72
92
  }
73
93
 
74
- function createForBase64(
75
- status: number,
76
- base64Body: string,
77
- fileName?: string
78
- ): LambdaResponse {
79
- return new LambdaResponse(status, base64Body, fileName);
94
+ function toBase64(body: string) {
95
+ return Buffer.from(body).toString("base64");
80
96
  }
package/src/types/nullable.ts ADDED
@@ -0,0 +1,21 @@
1
+ import { ValueOf } from "./util-types";
2
+
3
+ /**
4
+ * Adds `null` as an accepted type to all properties in given type.
5
+ */
6
+ export type Nullable<Obj> = { [Key in keyof Obj]: Obj[Key] | null };
7
+
8
+ type RequiredKeys<Obj> = ValueOf<{
9
+ [Key in keyof Obj]-?: object extends { [K in Key]: Obj[Key] } ? never : Key;
10
+ }>;
11
+ type OptionalKeys<Obj> = ValueOf<{
12
+ [Key in keyof Obj]-?: object extends { [K in Key]: Obj[Key] } ? Key : never;
13
+ }>;
14
+ type RequiredProperties<Obj> = Pick<Obj, RequiredKeys<Obj>>;
15
+ type OptionalProperties<Obj> = Pick<Obj, OptionalKeys<Obj>>;
16
+
17
+ /**
18
+ * Adds `null` as an accepted type to all optional properties in given type. Required properties remain unchanged.
19
+ */
20
+ export type NullableOptional<Obj> = RequiredProperties<Obj> &
21
+ Nullable<OptionalProperties<Obj>>;
package/src/types/util-types.ts ADDED
@@ -0,0 +1 @@
1
+ export type ValueOf<Obj> = Obj[keyof Obj];