@aligent/microservice-util-lib 0.1.2 → 0.2.0

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.
@@ -1,12 +1,12 @@
1
- import { SSM } from 'aws-sdk';
1
+ import { Parameter } from '@aws-sdk/client-ssm';
2
2
  /**
3
3
  * Fetch one SSM parameter
4
4
  * @param param key of the parameter to fetch
5
5
  */
6
- declare function fetchSsmParams(param: string): Promise<SSM.Parameter>;
6
+ declare function fetchSsmParams(param: string): Promise<Parameter>;
7
7
  /**
8
8
  * Fetch a list of SSM parameters
9
9
  * @param params list of parameter keys to fetch
10
10
  */
11
- declare function fetchSsmParams(...params: string[]): Promise<SSM.ParameterList>;
11
+ declare function fetchSsmParams(...params: string[]): Promise<Parameter[]>;
12
12
  export default fetchSsmParams;
@@ -36,8 +36,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
36
36
  }
37
37
  };
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- var aws_sdk_1 = require("aws-sdk");
40
- var ssm = new aws_sdk_1.SSM();
39
+ var client_ssm_1 = require("@aws-sdk/client-ssm");
40
+ var ssm = new client_ssm_1.SSMClient({});
41
41
  /**
42
42
  * Fetch SSM Parameters
43
43
  * @param params the keys of the parameters to fetch
@@ -56,19 +56,17 @@ function fetchSsmParams() {
56
56
  throw new Error('No SSM Params supplied');
57
57
  }
58
58
  if (!(params.length === 1)) return [3 /*break*/, 2];
59
- return [4 /*yield*/, ssm.getParameter({
59
+ return [4 /*yield*/, ssm.send(new client_ssm_1.GetParameterCommand({
60
60
  Name: params[0],
61
61
  WithDecryption: true
62
- })
63
- .promise()];
62
+ }))];
64
63
  case 1:
65
64
  result_1 = _a.sent();
66
65
  return [2 /*return*/, result_1.Parameter];
67
- case 2: return [4 /*yield*/, ssm.getParameters({
66
+ case 2: return [4 /*yield*/, ssm.send(new client_ssm_1.GetParametersCommand({
68
67
  Names: params,
69
68
  WithDecryption: true
70
- })
71
- .promise()];
69
+ }))];
72
70
  case 3:
73
71
  result = _a.sent();
74
72
  return [2 /*return*/, params.map(function (paramName) {
@@ -1 +1 @@
1
- {"version":3,"file":"fetchSsmParams.js","sourceRoot":"","sources":["../../src/fetchSsmParams/fetchSsmParams.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA8B;AAE9B,IAAM,GAAG,GAAG,IAAI,aAAG,EAAE,CAAC;AAgBtB;;;GAGG;AACH,SAAe,cAAc;IAAC,gBAAmB;SAAnB,UAAmB,EAAnB,qBAAmB,EAAnB,IAAmB;QAAnB,2BAAmB;;;;;;;oBAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;wBACvB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;qBAC3C;yBAEG,CAAA,MAAM,CAAC,MAAM,KAAK,CAAC,CAAA,EAAnB,wBAAmB;oBACN,qBAAM,GAAG,CAAC,YAAY,CAAC;4BACpC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;4BACf,cAAc,EAAE,IAAI;yBACrB,CAAC;6BACC,OAAO,EAAE,EAAA;;oBAJN,WAAS,SAIH;oBACZ,sBAAO,QAAM,CAAC,SAAS,EAAC;wBAGX,qBAAM,GAAG,CAAC,aAAa,CAAC;wBACrC,KAAK,EAAE,MAAM;wBACb,cAAc,EAAE,IAAI;qBACrB,CAAC;yBACC,OAAO,EAAE,EAAA;;oBAJN,MAAM,GAAG,SAIH;oBAEZ,sBAAO,MAAM,CAAC,GAAG,CAAC,UAAA,SAAS;4BACzB,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,IAAI,KAAK,SAAS,EAAxB,CAAwB,CAAC,CAAC;wBACnE,CAAC,CAAC,EAAC;;;;CACJ;AAED,kBAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"fetchSsmParams.js","sourceRoot":"","sources":["../../src/fetchSsmParams/fetchSsmParams.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAK6B;AAE7B,IAAM,GAAG,GAAG,IAAI,sBAAS,CAAC,EAAE,CAAC,CAAC;AAgB9B;;;GAGG;AACH,SAAe,cAAc;IAAC,gBAAmB;SAAnB,UAAmB,EAAnB,qBAAmB,EAAnB,IAAmB;QAAnB,2BAAmB;;;;;;;oBAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;wBACvB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;qBAC3C;yBAEG,CAAA,MAAM,CAAC,MAAM,KAAK,CAAC,CAAA,EAAnB,wBAAmB;oBACN,qBAAM,GAAG,CAAC,IAAI,CAAC,IAAI,gCAAmB,CAAC;4BACpD,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;4BACf,cAAc,EAAE,IAAI;yBACrB,CAAC,CAAC,EAAA;;oBAHG,WAAS,SAGZ;oBAEH,sBAAO,QAAM,CAAC,SAAS,EAAC;wBAGX,qBAAM,GAAG,CAAC,IAAI,CAAC,IAAI,iCAAoB,CAAC;wBACrD,KAAK,EAAE,MAAM;wBACb,cAAc,EAAE,IAAI;qBACrB,CAAC,CAAC,EAAA;;oBAHG,MAAM,GAAG,SAGZ;oBAEH,sBAAO,MAAM,CAAC,GAAG,CAAC,UAAA,SAAS;4BACzB,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,IAAI,KAAK,SAAS,EAAxB,CAAwB,CAAC,CAAC;wBACnE,CAAC,CAAC,EAAC;;;;CACJ;AAED,kBAAe,cAAc,CAAC"}
@@ -1 +1 @@
1
- export {};
1
+ import 'aws-sdk-client-mock-jest';
@@ -40,22 +40,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
40
40
  };
41
41
  Object.defineProperty(exports, "__esModule", { value: true });
42
42
  var fetchSsmParams_1 = __importDefault(require("./fetchSsmParams"));
43
- var getParam = jest.fn();
44
- var getParams = jest.fn();
45
- jest.mock('aws-sdk', function () {
46
- return {
47
- SSM: jest.fn().mockImplementation(function () {
48
- return {
49
- getParameter: function () { return ({ promise: getParam }); },
50
- getParameters: function () { return ({ promise: getParams }); }
51
- };
52
- })
53
- };
54
- });
43
+ var aws_sdk_client_mock_1 = require("aws-sdk-client-mock");
44
+ var client_ssm_1 = require("@aws-sdk/client-ssm");
45
+ require("aws-sdk-client-mock-jest");
46
+ var ssmMock = (0, aws_sdk_client_mock_1.mockClient)(client_ssm_1.SSMClient);
55
47
  describe('fetchSsmParams', function () {
56
48
  afterEach(function () {
57
- getParam.mockReset();
58
- getParams.mockReset();
49
+ ssmMock.reset();
59
50
  });
60
51
  it('should error when no params are passed', function () { return __awaiter(void 0, void 0, void 0, function () {
61
52
  var ex_1;
@@ -89,8 +80,8 @@ describe('fetchSsmParams', function () {
89
80
  _a = _b.sent();
90
81
  return [3 /*break*/, 3];
91
82
  case 3:
92
- expect(getParam).toHaveBeenCalledTimes(1);
93
- expect(getParams).toHaveBeenCalledTimes(0);
83
+ expect(ssmMock).toHaveReceivedCommandTimes(client_ssm_1.GetParameterCommand, 1);
84
+ expect(ssmMock).toHaveReceivedCommandTimes(client_ssm_1.GetParametersCommand, 0);
94
85
  return [2 /*return*/];
95
86
  }
96
87
  });
@@ -109,8 +100,8 @@ describe('fetchSsmParams', function () {
109
100
  _a = _b.sent();
110
101
  return [3 /*break*/, 3];
111
102
  case 3:
112
- expect(getParam).toHaveBeenCalledTimes(0);
113
- expect(getParams).toHaveBeenCalledTimes(1);
103
+ expect(ssmMock).toHaveReceivedCommandTimes(client_ssm_1.GetParameterCommand, 0);
104
+ expect(ssmMock).toHaveReceivedCommandTimes(client_ssm_1.GetParametersCommand, 1);
114
105
  return [2 /*return*/];
115
106
  }
116
107
  });
@@ -1 +1 @@
1
- {"version":3,"file":"fetchSsmParams.test.js","sourceRoot":"","sources":["../../src/fetchSsmParams/fetchSsmParams.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAA8C;AAE9C,IAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAC3B,IAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAE5B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;IACnB,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC;YAChC,OAAO;gBACL,YAAY,EAAE,cAAM,OAAA,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAvB,CAAuB;gBAC3C,aAAa,EAAE,cAAM,OAAA,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,EAAxB,CAAwB;aAC9C,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE;IAEzB,SAAS,CAAC;QACR,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrB,SAAS,CAAC,SAAS,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE;;;;;;oBAEzC,qBAAM,IAAA,wBAAc,GAAE,EAAA;;oBAAtB,SAAsB,CAAC;;;;oBAEvB,MAAM,CAAC,IAAE,CAAC,CAAC,UAAU,EAAE,CAAC;;;;;SAE3B,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE;;;;;;oBAE1D,qBAAM,IAAA,wBAAc,EAAC,EAAE,CAAC,EAAA;;oBAAxB,SAAwB,CAAC;;;;;;oBAG3B,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;oBAC1C,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SAC5C,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAClE;;;;;;oBAEI,qBAAM,IAAA,wBAAc,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;oBAAhC,SAAgC,CAAC;;;;;;oBAGnC,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;oBAC1C,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SAC5C,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"fetchSsmParams.test.js","sourceRoot":"","sources":["../../src/fetchSsmParams/fetchSsmParams.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAA8C;AAC9C,2DAAiD;AACjD,kDAI6B;AAC7B,oCAAkC;AAElC,IAAM,OAAO,GAAG,IAAA,gCAAU,EAAC,sBAAS,CAAC,CAAC;AAEtC,QAAQ,CAAC,gBAAgB,EAAE;IAEzB,SAAS,CAAC;QACR,OAAO,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE;;;;;;oBAEzC,qBAAM,IAAA,wBAAc,GAAE,EAAA;;oBAAtB,SAAsB,CAAC;;;;oBAEvB,MAAM,CAAC,IAAE,CAAC,CAAC,UAAU,EAAE,CAAC;;;;;SAE3B,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE;;;;;;oBAE1D,qBAAM,IAAA,wBAAc,EAAC,EAAE,CAAC,EAAA;;oBAAxB,SAAwB,CAAC;;;;;;oBAG3B,MAAM,CAAC,OAAO,CAAC,CAAC,0BAA0B,CAAC,gCAAmB,EAAE,CAAC,CAAC,CAAC;oBACnE,MAAM,CAAC,OAAO,CAAC,CAAC,0BAA0B,CAAC,iCAAoB,EAAE,CAAC,CAAC,CAAC;;;;SACrE,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAClE;;;;;;oBAEI,qBAAM,IAAA,wBAAc,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;oBAAhC,SAAgC,CAAC;;;;;;oBAGnC,MAAM,CAAC,OAAO,CAAC,CAAC,0BAA0B,CAAC,gCAAmB,EAAE,CAAC,CAAC,CAAC;oBACnE,MAAM,CAAC,OAAO,CAAC,CAAC,0BAA0B,CAAC,iCAAoB,EAAE,CAAC,CAAC,CAAC;;;;SACrE,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
package/dist/s3/s3.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { S3 } from 'aws-sdk';
1
+ import { GetObjectCommandInput } from '@aws-sdk/client-s3';
2
2
  /** A data access object for an S3 bucket */
3
3
  declare class S3Dao {
4
4
  private s3;
@@ -13,35 +13,35 @@ declare class S3Dao {
13
13
  * @param name the name to call the object in S3 @default the hash of the data
14
14
  * @returns an object which can be used to fetch the data
15
15
  */
16
- storeData<T>(data: T, name?: string): Promise<S3.GetObjectRequest>;
16
+ storeData<T>(data: T, name?: string): Promise<GetObjectCommandInput>;
17
17
  /**
18
18
  * Store an array of object as individual chunks in S3
19
19
  * @param data the data to store
20
20
  * @param chunkSize the number of entries that should be in each chunk
21
21
  * @returns an array of objects which can be used to fetch the chunks
22
22
  */
23
- storeChunked<T extends any[]>(data: T, chunkSize: number): Promise<S3.GetObjectRequest[]>;
23
+ storeChunked<T extends any[]>(data: T, chunkSize: number): Promise<GetObjectCommandInput[]>;
24
24
  /**
25
25
  * Fetch an object from the S3 bucket
26
26
  * @param objectDetails the object which describes the location of the object
27
27
  * @returns the body of the object
28
28
  */
29
- fetchData<T>(objectDetails: S3.GetObjectRequest): Promise<T>;
29
+ fetchData<T>(objectDetails: GetObjectCommandInput): Promise<T>;
30
30
  /**
31
31
  * Generator to fetch chunked data, chunk by chunk
32
32
  * @param chunks the list of object chunks
33
33
  */
34
- fetchChunks<T>(chunks: S3.GetObjectRequest[]): AsyncGenerator<{
34
+ fetchChunks<T>(chunks: GetObjectCommandInput[]): AsyncGenerator<{
35
35
  chunk: T;
36
- s3Object: S3.GetObjectRequest;
36
+ s3Object: GetObjectCommandInput;
37
37
  }, {
38
38
  chunk: T;
39
- s3Object: S3.GetObjectRequest;
39
+ s3Object: GetObjectCommandInput;
40
40
  }, unknown>;
41
41
  /**
42
42
  * Delete an object from the S3 bucket
43
43
  * @param objectDetails the object to delete
44
44
  */
45
- deleteData(objectDetails: S3.GetObjectRequest): Promise<import("aws-sdk/lib/request").PromiseResult<S3.DeleteObjectOutput, import("aws-sdk").AWSError>>;
45
+ deleteData(objectDetails: GetObjectCommandInput): Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
46
46
  }
47
47
  export default S3Dao;
package/dist/s3/s3.js CHANGED
@@ -62,7 +62,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
62
62
  return (mod && mod.__esModule) ? mod : { "default": mod };
63
63
  };
64
64
  Object.defineProperty(exports, "__esModule", { value: true });
65
- var aws_sdk_1 = require("aws-sdk");
65
+ var client_s3_1 = require("@aws-sdk/client-s3");
66
66
  var object_hash_1 = __importDefault(require("object-hash"));
67
67
  var chunkBy_1 = __importDefault(require("../chunkBy/chunkBy"));
68
68
  /** A data access object for an S3 bucket */
@@ -72,7 +72,7 @@ var S3Dao = /** @class */ (function () {
72
72
  */
73
73
  function S3Dao(bucket) {
74
74
  this.bucket = bucket;
75
- this.s3 = new aws_sdk_1.S3();
75
+ this.s3 = new client_s3_1.S3Client({});
76
76
  }
77
77
  /**
78
78
  * Store data in an S3 bucket
@@ -93,7 +93,7 @@ var S3Dao = /** @class */ (function () {
93
93
  Bucket: this.bucket,
94
94
  Key: name || (0, object_hash_1.default)(data)
95
95
  };
96
- return [4 /*yield*/, this.s3.putObject(__assign(__assign({}, getObject), { Body: JSON.stringify(data) })).promise()];
96
+ return [4 /*yield*/, this.s3.send(new client_s3_1.PutObjectCommand(__assign(__assign({}, getObject), { Body: JSON.stringify(data) })))];
97
97
  case 1:
98
98
  _a.sent();
99
99
  return [2 /*return*/, getObject];
@@ -112,12 +112,8 @@ var S3Dao = /** @class */ (function () {
112
112
  var chunks;
113
113
  var _this = this;
114
114
  return __generator(this, function (_a) {
115
- switch (_a.label) {
116
- case 0:
117
- chunks = (0, chunkBy_1.default)(data, chunkSize);
118
- return [4 /*yield*/, Promise.all(chunks.map(function (chunk) { return _this.storeData(chunk); }))];
119
- case 1: return [2 /*return*/, _a.sent()];
120
- }
115
+ chunks = (0, chunkBy_1.default)(data, chunkSize);
116
+ return [2 /*return*/, Promise.all(chunks.map(function (chunk) { return _this.storeData(chunk); }))];
121
117
  });
122
118
  });
123
119
  };
@@ -131,7 +127,7 @@ var S3Dao = /** @class */ (function () {
131
127
  var data;
132
128
  return __generator(this, function (_a) {
133
129
  switch (_a.label) {
134
- case 0: return [4 /*yield*/, this.s3.getObject(objectDetails).promise()];
130
+ case 0: return [4 /*yield*/, this.s3.send(new client_s3_1.GetObjectCommand(objectDetails))];
135
131
  case 1:
136
132
  data = _a.sent();
137
133
  return [2 /*return*/, JSON.parse(data.Body.toString())];
@@ -183,10 +179,7 @@ var S3Dao = /** @class */ (function () {
183
179
  S3Dao.prototype.deleteData = function (objectDetails) {
184
180
  return __awaiter(this, void 0, void 0, function () {
185
181
  return __generator(this, function (_a) {
186
- switch (_a.label) {
187
- case 0: return [4 /*yield*/, this.s3.deleteObject(objectDetails).promise()];
188
- case 1: return [2 /*return*/, _a.sent()];
189
- }
182
+ return [2 /*return*/, this.s3.send(new client_s3_1.DeleteObjectCommand(objectDetails))];
190
183
  });
191
184
  });
192
185
  };
package/dist/s3/s3.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"s3.js","sourceRoot":"","sources":["../../src/s3/s3.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA6B;AAC7B,4DAA+B;AAE/B,+DAAyC;AAEzC,4CAA4C;AAC5C;IAIE;;OAEG;IACH,eAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,EAAE,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACU,yBAAS,GAAtB,UACE,IAAO,EACP,IAAa;;;;;;wBAEb,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;yBACtC;wBACK,SAAS,GAAwB;4BACrC,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,GAAG,EAAE,IAAI,IAAI,IAAA,qBAAI,EAAC,IAAW,CAAC;yBAC/B,CAAC;wBAEF,qBAAM,IAAI,CAAC,EAAE,CAAC,SAAS,uBAClB,SAAS,KACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAC1B,CAAC,OAAO,EAAE,EAAA;;wBAHZ,SAGY,CAAC;wBAEb,sBAAO,SAAS,EAAC;;;;KAClB;IAED;;;;;OAKG;IACU,4BAAY,GAAzB,UAA2C,IAAO,EAAE,SAAiB;;;;;;;wBAC7D,MAAM,GAAG,IAAA,iBAAO,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;wBACjC,qBAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,CAAC,EAAA;4BAApE,sBAAO,SAA6D,EAAC;;;;KACtE;IAED;;;;OAIG;IACU,yBAAS,GAAtB,UAA0B,aAAkC;;;;;4BAC7C,qBAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,EAAA;;wBAAvD,IAAI,GAAG,SAAgD;wBAC7D,sBAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAC;;;;KACzC;IAED;;;OAGG;IACW,2BAAW,GAAzB,UAA6B,MAA6B;;;;;;wBAC/C,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;wBACd,6BAAM,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAA;;wBAA7C,KAAK,GAAM,SAAkC;wBAE7C,QAAQ,GAAG;4BACf,KAAK,OAAA;4BACL,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;yBACpB,CAAC;6BAEE,CAAA,CAAC,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA,EAAvB,wBAAuB;qDAClB,QAAQ;4BAAf,iCAAgB;yDAEZ,QAAQ;4BAAd,gCAAc;;wBAAd,SAAc,CAAC;;;wBAXkB,CAAC,EAAE,CAAA;;;;;;KAavC;IAED;;;OAGG;IACU,0BAAU,GAAvB,UAAwB,aAAkC;;;;4BACjD,qBAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,EAAA;4BAA1D,sBAAO,SAAmD,EAAC;;;;KAC5D;IACH,YAAC;AAAD,CAAC,AAtFD,IAsFC;AAED,kBAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"s3.js","sourceRoot":"","sources":["../../src/s3/s3.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAM4B;AAC5B,4DAA+B;AAC/B,+DAAyC;AAEzC,4CAA4C;AAC5C;IAIE;;OAEG;IACH,eAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,oBAAQ,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACU,yBAAS,GAAtB,UACE,IAAO,EACP,IAAa;;;;;;wBAEb,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;yBACtC;wBAEK,SAAS,GAA0B;4BACvC,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,GAAG,EAAE,IAAI,IAAI,IAAA,qBAAI,EAAC,IAAW,CAAC;yBAC/B,CAAC;wBAEF,qBAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,4BAAgB,uBAClC,SAAS,KACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAC1B,CAAC,EAAA;;wBAHH,SAGG,CAAC;wBAEJ,sBAAO,SAAS,EAAC;;;;KAClB;IAED;;;;;OAKG;IACU,4BAAY,GAAzB,UAA2C,IAAO,EAAE,SAAiB;;;;;gBAC7D,MAAM,GAAG,IAAA,iBAAO,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACxC,sBAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,CAAC,EAAC;;;KAChE;IAED;;;;OAIG;IACU,yBAAS,GAAtB,UAA0B,aAAoC;;;;;4BAC/C,qBAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,4BAAgB,CAAC,aAAa,CAAC,CAAC,EAAA;;wBAA9D,IAAI,GAAG,SAAuD;wBACpE,sBAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAC;;;;KACzC;IAED;;;OAGG;IACW,2BAAW,GAAzB,UAA6B,MAA+B;;;;;;wBACjD,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;wBACd,6BAAM,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAA;;wBAA7C,KAAK,GAAM,SAAkC;wBAE7C,QAAQ,GAAG;4BACf,KAAK,OAAA;4BACL,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;yBACpB,CAAC;6BAEE,CAAA,CAAC,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA,EAAvB,wBAAuB;qDAClB,QAAQ;4BAAf,iCAAgB;yDAEZ,QAAQ;4BAAd,gCAAc;;wBAAd,SAAc,CAAC;;;wBAXkB,CAAC,EAAE,CAAA;;;;;;KAavC;IAED;;;OAGG;IACU,0BAAU,GAAvB,UAAwB,aAAoC;;;gBAC1D,sBAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,+BAAmB,CAAC,aAAa,CAAC,CAAC,EAAC;;;KAC7D;IACH,YAAC;AAAD,CAAC,AAvFD,IAuFC;AAED,kBAAe,KAAK,CAAC"}
@@ -37,7 +37,7 @@ A data access object for an S3 bucket
37
37
 
38
38
  #### Defined in
39
39
 
40
- [s3/s3.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-14)
40
+ [s3/s3.ts:19](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-19)
41
41
 
42
42
  ## Properties
43
43
 
@@ -47,23 +47,23 @@ A data access object for an S3 bucket
47
47
 
48
48
  #### Defined in
49
49
 
50
- [s3/s3.ts:9](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-9)
50
+ [s3/s3.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-14)
51
51
 
52
52
  ___
53
53
 
54
54
  ### <a id="s3" name="s3"></a> s3
55
55
 
56
- • `Private` **s3**: `S3`
56
+ • `Private` **s3**: `S3Client`
57
57
 
58
58
  #### Defined in
59
59
 
60
- [s3/s3.ts:8](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-8)
60
+ [s3/s3.ts:13](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-13)
61
61
 
62
62
  ## Methods
63
63
 
64
64
  ### <a id="deletedata" name="deletedata"></a> deleteData
65
65
 
66
- ▸ **deleteData**(`objectDetails`): `Promise`<`PromiseResult`<`DeleteObjectOutput`, `AWSError`\>\>
66
+ ▸ **deleteData**(`objectDetails`): `Promise`<`DeleteObjectCommandOutput`\>
67
67
 
68
68
  Delete an object from the S3 bucket
69
69
 
@@ -71,21 +71,21 @@ Delete an object from the S3 bucket
71
71
 
72
72
  | Name | Type | Description |
73
73
  | :------ | :------ | :------ |
74
- | `objectDetails` | `GetObjectRequest` | the object to delete |
74
+ | `objectDetails` | `GetObjectCommandInput` | the object to delete |
75
75
 
76
76
  #### Returns
77
77
 
78
- `Promise`<`PromiseResult`<`DeleteObjectOutput`, `AWSError`\>\>
78
+ `Promise`<`DeleteObjectCommandOutput`\>
79
79
 
80
80
  #### Defined in
81
81
 
82
- [s3/s3.ts:90](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-90)
82
+ [s3/s3.ts:96](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-96)
83
83
 
84
84
  ___
85
85
 
86
86
  ### <a id="fetchchunks" name="fetchchunks"></a> fetchChunks
87
87
 
88
- ▸ **fetchChunks**<`T`\>(`chunks`): `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectRequest` }, { `chunk`: `T` ; `s3Object`: `GetObjectRequest` }, `unknown`\>
88
+ ▸ **fetchChunks**<`T`\>(`chunks`): `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectCommandInput` }, { `chunk`: `T` ; `s3Object`: `GetObjectCommandInput` }, `unknown`\>
89
89
 
90
90
  Generator to fetch chunked data, chunk by chunk
91
91
 
@@ -99,15 +99,15 @@ Generator to fetch chunked data, chunk by chunk
99
99
 
100
100
  | Name | Type | Description |
101
101
  | :------ | :------ | :------ |
102
- | `chunks` | `GetObjectRequest`[] | the list of object chunks |
102
+ | `chunks` | `GetObjectCommandInput`[] | the list of object chunks |
103
103
 
104
104
  #### Returns
105
105
 
106
- `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectRequest` }, { `chunk`: `T` ; `s3Object`: `GetObjectRequest` }, `unknown`\>
106
+ `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectCommandInput` }, { `chunk`: `T` ; `s3Object`: `GetObjectCommandInput` }, `unknown`\>
107
107
 
108
108
  #### Defined in
109
109
 
110
- [s3/s3.ts:70](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-70)
110
+ [s3/s3.ts:76](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-76)
111
111
 
112
112
  ___
113
113
 
@@ -127,7 +127,7 @@ Fetch an object from the S3 bucket
127
127
 
128
128
  | Name | Type | Description |
129
129
  | :------ | :------ | :------ |
130
- | `objectDetails` | `GetObjectRequest` | the object which describes the location of the object |
130
+ | `objectDetails` | `GetObjectCommandInput` | the object which describes the location of the object |
131
131
 
132
132
  #### Returns
133
133
 
@@ -137,13 +137,13 @@ the body of the object
137
137
 
138
138
  #### Defined in
139
139
 
140
- [s3/s3.ts:61](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-61)
140
+ [s3/s3.ts:67](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-67)
141
141
 
142
142
  ___
143
143
 
144
144
  ### <a id="storechunked" name="storechunked"></a> storeChunked
145
145
 
146
- ▸ **storeChunked**<`T`\>(`data`, `chunkSize`): `Promise`<`GetObjectRequest`[]\>
146
+ ▸ **storeChunked**<`T`\>(`data`, `chunkSize`): `Promise`<`GetObjectCommandInput`[]\>
147
147
 
148
148
  Store an array of object as individual chunks in S3
149
149
 
@@ -162,19 +162,19 @@ Store an array of object as individual chunks in S3
162
162
 
163
163
  #### Returns
164
164
 
165
- `Promise`<`GetObjectRequest`[]\>
165
+ `Promise`<`GetObjectCommandInput`[]\>
166
166
 
167
167
  an array of objects which can be used to fetch the chunks
168
168
 
169
169
  #### Defined in
170
170
 
171
- [s3/s3.ts:51](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-51)
171
+ [s3/s3.ts:57](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-57)
172
172
 
173
173
  ___
174
174
 
175
175
  ### <a id="storedata" name="storedata"></a> storeData
176
176
 
177
- ▸ **storeData**<`T`\>(`data`, `name?`): `Promise`<`GetObjectRequest`\>
177
+ ▸ **storeData**<`T`\>(`data`, `name?`): `Promise`<`GetObjectCommandInput`\>
178
178
 
179
179
  Store data in an S3 bucket
180
180
 
@@ -197,10 +197,10 @@ the hash of the data
197
197
 
198
198
  #### Returns
199
199
 
200
- `Promise`<`GetObjectRequest`\>
200
+ `Promise`<`GetObjectCommandInput`\>
201
201
 
202
202
  an object which can be used to fetch the data
203
203
 
204
204
  #### Defined in
205
205
 
206
- [s3/s3.ts:25](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/s3/s3.ts#lines-25)
206
+ [s3/s3.ts:30](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/s3/s3.ts#lines-30)
@@ -27,7 +27,7 @@ The amount to increase the delay by each retry (in ms)
27
27
 
28
28
  #### Defined in
29
29
 
30
- [retryWrapper/retryWrapper.ts:17](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/retryWrapper/retryWrapper.ts#lines-17)
30
+ [retryWrapper/retryWrapper.ts:17](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/retryWrapper/retryWrapper.ts#lines-17)
31
31
 
32
32
  ___
33
33
 
@@ -43,7 +43,7 @@ The base delay between retries (in ms)
43
43
 
44
44
  #### Defined in
45
45
 
46
- [retryWrapper/retryWrapper.ts:12](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/retryWrapper/retryWrapper.ts#lines-12)
46
+ [retryWrapper/retryWrapper.ts:12](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/retryWrapper/retryWrapper.ts#lines-12)
47
47
 
48
48
  ___
49
49
 
@@ -71,7 +71,7 @@ A callback to run before each retry
71
71
 
72
72
  #### Defined in
73
73
 
74
- [retryWrapper/retryWrapper.ts:24](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/retryWrapper/retryWrapper.ts#lines-24)
74
+ [retryWrapper/retryWrapper.ts:24](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/retryWrapper/retryWrapper.ts#lines-24)
75
75
 
76
76
  ___
77
77
 
@@ -87,4 +87,4 @@ The number of retries to attempt after the first run
87
87
 
88
88
  #### Defined in
89
89
 
90
- [retryWrapper/retryWrapper.ts:7](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/retryWrapper/retryWrapper.ts#lines-7)
90
+ [retryWrapper/retryWrapper.ts:7](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/retryWrapper/retryWrapper.ts#lines-7)
package/docs/modules.md CHANGED
@@ -35,7 +35,7 @@ A list of keys to keys, with an optional transformer function
35
35
 
36
36
  #### Defined in
37
37
 
38
- [remap/remap.ts:15](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/remap/remap.ts#lines-15)
38
+ [remap/remap.ts:15](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/remap/remap.ts#lines-15)
39
39
 
40
40
  ___
41
41
 
@@ -52,7 +52,7 @@ ___
52
52
 
53
53
  #### Defined in
54
54
 
55
- [remap/remap.ts:159](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/remap/remap.ts#lines-159)
55
+ [remap/remap.ts:159](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/remap/remap.ts#lines-159)
56
56
 
57
57
  ## Functions
58
58
 
@@ -87,13 +87,13 @@ chunkBy([1, 2, 3, 4, 5, 6, 7], 2) // [[1, 2], [3, 4], [5, 6], [7]]
87
87
 
88
88
  #### Defined in
89
89
 
90
- [chunkBy/chunkBy.ts:10](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/chunkBy/chunkBy.ts#lines-10)
90
+ [chunkBy/chunkBy.ts:10](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/chunkBy/chunkBy.ts#lines-10)
91
91
 
92
92
  ___
93
93
 
94
94
  ### <a id="fetchssmparams" name="fetchssmparams"></a> fetchSsmParams
95
95
 
96
- ▸ **fetchSsmParams**(`param`): `Promise`<`SSM.Parameter`\>
96
+ ▸ **fetchSsmParams**(`param`): `Promise`<`Parameter`\>
97
97
 
98
98
  Fetch one SSM parameter
99
99
 
@@ -105,13 +105,13 @@ Fetch one SSM parameter
105
105
 
106
106
  #### Returns
107
107
 
108
- `Promise`<`SSM.Parameter`\>
108
+ `Promise`<`Parameter`\>
109
109
 
110
110
  #### Defined in
111
111
 
112
- [fetchSsmParams/fetchSsmParams.ts:9](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/fetchSsmParams/fetchSsmParams.ts#lines-9)
112
+ [fetchSsmParams/fetchSsmParams.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/fetchSsmParams/fetchSsmParams.ts#lines-14)
113
113
 
114
- ▸ **fetchSsmParams**(`...params`): `Promise`<`SSM.ParameterList`\>
114
+ ▸ **fetchSsmParams**(`...params`): `Promise`<`Parameter`[]\>
115
115
 
116
116
  Fetch a list of SSM parameters
117
117
 
@@ -123,11 +123,11 @@ Fetch a list of SSM parameters
123
123
 
124
124
  #### Returns
125
125
 
126
- `Promise`<`SSM.ParameterList`\>
126
+ `Promise`<`Parameter`[]\>
127
127
 
128
128
  #### Defined in
129
129
 
130
- [fetchSsmParams/fetchSsmParams.ts:16](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/fetchSsmParams/fetchSsmParams.ts#lines-16)
130
+ [fetchSsmParams/fetchSsmParams.ts:21](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/fetchSsmParams/fetchSsmParams.ts#lines-21)
131
131
 
132
132
  ___
133
133
 
@@ -173,7 +173,7 @@ obj is SimplifyIntersection<Required<Pick<T, K\>\> & Omit<T, K\>\>
173
173
 
174
174
  #### Defined in
175
175
 
176
- [hasPropertiesDefined/hasPropertiesDefined.ts:22](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/hasPropertiesDefined/hasPropertiesDefined.ts#lines-22)
176
+ [hasPropertiesDefined/hasPropertiesDefined.ts:22](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/hasPropertiesDefined/hasPropertiesDefined.ts#lines-22)
177
177
 
178
178
  ___
179
179
 
@@ -240,7 +240,7 @@ the remapped object
240
240
 
241
241
  #### Defined in
242
242
 
243
- [remap/remap.ts:198](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/remap/remap.ts#lines-198)
243
+ [remap/remap.ts:198](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/remap/remap.ts#lines-198)
244
244
 
245
245
  ___
246
246
 
@@ -278,4 +278,4 @@ retryWrapper(someAsyncFunction, {
278
278
 
279
279
  #### Defined in
280
280
 
281
- [retryWrapper/retryWrapper.ts:78](https://bitbucket.org/aligent/microservice-util-lib/src/c10e547/src/retryWrapper/retryWrapper.ts#lines-78)
281
+ [retryWrapper/retryWrapper.ts:78](https://bitbucket.org/aligent/microservice-util-lib/src/4dfd26a/src/retryWrapper/retryWrapper.ts#lines-78)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aligent/microservice-util-lib",
3
- "version": "0.1.2",
3
+ "version": "0.2.0",
4
4
  "description": "A set of utility functions for Aligent Microservices",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -14,7 +14,7 @@
14
14
  },
15
15
  "repository": {
16
16
  "type": "git",
17
- "url": "git+ssh://git@bitbucket.org/aligent/microservices-util-lib.git"
17
+ "url": "git+ssh://git@bitbucket.org/aligent/microservice-util-lib.git"
18
18
  },
19
19
  "author": "Aligent",
20
20
  "license": "ISC",
@@ -25,6 +25,8 @@
25
25
  "@types/object-hash": "^3.0.2",
26
26
  "@typescript-eslint/eslint-plugin": "^5.46.1",
27
27
  "@typescript-eslint/parser": "^5.46.1",
28
+ "aws-sdk-client-mock": "^2.1.1",
29
+ "aws-sdk-client-mock-jest": "^2.1.1",
28
30
  "eslint": "^8.30.0",
29
31
  "jest": "^29.3.1",
30
32
  "ts-jest": "^29.0.3",
@@ -33,7 +35,8 @@
33
35
  "typescript": "^4.9.4"
34
36
  },
35
37
  "dependencies": {
36
- "aws-sdk": "^2.1281.0",
38
+ "@aws-sdk/client-s3": "^3.332.0",
39
+ "@aws-sdk/client-ssm": "^3.332.0",
37
40
  "axios": "^1.2.1",
38
41
  "lodash": "^4.17.21",
39
42
  "object-hash": "^3.0.0"
@@ -42,4 +45,4 @@
42
45
  "dist",
43
46
  "docs"
44
47
  ]
45
- }
48
+ }