Skip to content

Commit 75b4df1

Browse files
simontaborsimontabor
authored
Merge pull request #227 from lkhari/client-typings
feat: typings for clients
2 parents 17674c2 + e823932 commit 75b4df1

18 files changed

Lines changed: 187 additions & 0 deletions

File tree

‎packages/lambda-powertools-cloudwatchevents-client/index.d.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import awsCloudWatchEvents from "aws-sdk/clients/cloudwatchevents";
2+
import { AWSError } from "aws-sdk/lib/error";
3+
import { Request } from "aws-sdk/lib/request";
4+
import CorrelationIds from "@dazn/lambda-powertools-correlation-ids";
5+
6+
declare const CloudWatchEvents: awsCloudWatchEvents & {
7+
putEventsWithCorrelationIds(
8+
correlationId: CorrelationIds,
9+
params: awsCloudWatchEvents.Types.PutEventsRequest,
10+
callback?: (
11+
err: AWSError,
12+
data: awsCloudWatchEvents.Types.PutEventsResponse
13+
) => void
14+
): Request<awsCloudWatchEvents.Types.PutEventsResponse, AWSError>;
15+
};
16+
export default CloudWatchEvents;

‎packages/lambda-powertools-cloudwatchevents-client/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.24.1",
44
"description": "CloudWatchEvents client wrapper that knows how to forward correlation IDs (captured via @dazn/lambda-powertools-correlation-ids)",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"dependencies": {
78
"@dazn/lambda-powertools-correlation-ids": "^1.24.1",
89
"@dazn/lambda-powertools-logger": "^1.24.1",

‎packages/lambda-powertools-dynamodb-client/index.d.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import { DocumentClient as awsDocumentClient } from "aws-sdk/clients/dynamodb";
2+
import { AWSError } from "aws-sdk/lib/error";
3+
import { Request } from "aws-sdk/lib/request";
4+
import CorrelationIds from "@dazn/lambda-powertools-correlation-ids";
5+
6+
declare const DocumentClient: awsDocumentClient & {
7+
putWithCorrelationIds(
8+
correlationId: CorrelationIds,
9+
params: awsDocumentClient.PutItemInput,
10+
callback?: (err: AWSError, data: awsDocumentClient.PutItemOutput) => void
11+
): Request<awsDocumentClient.PutItemOutput, AWSError>;
12+
updateWithCorrelationIds(
13+
correlationId: CorrelationIds,
14+
params: awsDocumentClient.UpdateItemInput,
15+
callback?: (err: AWSError, data: awsDocumentClient.UpdateItemOutput) => void
16+
): Request<awsDocumentClient.UpdateItemOutput, AWSError>;
17+
batchWriteWithCorrelationIds(
18+
correlationId: CorrelationIds,
19+
params: awsDocumentClient.BatchWriteItemInput,
20+
callback?: (
21+
err: AWSError,
22+
data: awsDocumentClient.BatchWriteItemOutput
23+
) => void
24+
): Request<awsDocumentClient.BatchWriteItemOutput, AWSError>;
25+
transactWriteWithCorrelationIds(
26+
correlationId: CorrelationIds,
27+
params: awsDocumentClient.TransactWriteItemsInput,
28+
callback?: (
29+
err: AWSError,
30+
data: awsDocumentClient.TransactWriteItemsOutput
31+
) => void
32+
): Request<awsDocumentClient.TransactWriteItemsOutput, AWSError>;
33+
};
34+
export default DocumentClient;

‎packages/lambda-powertools-dynamodb-client/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.24.1",
44
"description": "Lambda client wrapper that knows how to forward correlation IDs (captured via @dazn/lambda-powertools-correlation-ids)",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"license": "MIT",
78
"author": "Yan Cui",
89
"dependencies": {

‎packages/lambda-powertools-eventbridge-client/index.d.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import awsEventBridge from "aws-sdk/clients/eventbridge";
2+
import { AWSError } from "aws-sdk/lib/error";
3+
import { Request } from "aws-sdk/lib/request";
4+
import CorrelationIds from "@dazn/lambda-powertools-correlation-ids";
5+
6+
declare const EventBridge: awsEventBridge & {
7+
putEventsWithCorrelationIds(
8+
correlationId: CorrelationIds,
9+
params: awsEventBridge.Types.PutEventsRequest,
10+
callback?: (
11+
err: AWSError,
12+
data: awsEventBridge.Types.PutEventsResponse
13+
) => void
14+
): Request<awsEventBridge.Types.PutEventsResponse, AWSError>;
15+
};
16+
export default EventBridge;

‎packages/lambda-powertools-eventbridge-client/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.24.1",
44
"description": "EventBridge client wrapper that knows how to forward correlation IDs (captured via @dazn/lambda-powertools-correlation-ids)",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"dependencies": {
78
"@dazn/lambda-powertools-correlation-ids": "^1.24.1",
89
"@dazn/lambda-powertools-logger": "^1.24.1"

‎packages/lambda-powertools-firehose-client/index.d.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import awsFirehose from "aws-sdk/clients/firehose";
2+
import { AWSError } from "aws-sdk/lib/error";
3+
import { Request } from "aws-sdk/lib/request";
4+
import CorrelationIds from "@dazn/lambda-powertools-correlation-ids";
5+
6+
declare const Firehose: awsFirehose & {
7+
putRecordWithCorrelationIds(
8+
correlationId: CorrelationIds,
9+
params: awsFirehose.Types.PutRecordInput,
10+
callback?: (err: AWSError, data: awsFirehose.Types.PutRecordOutput) => void
11+
): Request<awsFirehose.Types.PutRecordOutput, AWSError>;
12+
13+
putRecordBatchWithCorrelationIds(
14+
correlationId: CorrelationIds,
15+
params: awsFirehose.Types.PutRecordBatchInput,
16+
callback?: (
17+
err: AWSError,
18+
data: awsFirehose.Types.PutRecordBatchOutput
19+
) => void
20+
): Request<awsFirehose.Types.PutRecordBatchOutput, AWSError>;
21+
};
22+
export default Firehose;

‎packages/lambda-powertools-firehose-client/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.24.1",
44
"description": "Firehose client wrapper that knows how to forward correlation IDs (captured via @dazn/lambda-powertools-correlation-ids)",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"license": "MIT",
78
"author": "Yan Cui",
89
"dependencies": {

‎packages/lambda-powertools-kinesis-client/index.d.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import awsKinesis from "aws-sdk/clients/kinesis";
2+
import { AWSError } from "aws-sdk/lib/error";
3+
import { Request } from "aws-sdk/lib/request";
4+
import CorrelationIds from "@dazn/lambda-powertools-correlation-ids";
5+
6+
declare const Kinesis: awsKinesis & {
7+
putRecordWithCorrelationIds(
8+
correlationId: CorrelationIds,
9+
params: awsKinesis.Types.PutRecordInput,
10+
callback?: (err: AWSError, data: awsKinesis.Types.PutRecordOutput) => void
11+
): Request<awsKinesis.Types.PutRecordOutput, AWSError>;
12+
putRecordsWithCorrelationIds(
13+
correlationId: CorrelationIds,
14+
params: awsKinesis.Types.PutRecordsInput,
15+
callback?: (err: AWSError, data: awsKinesis.Types.PutRecordsOutput) => void
16+
): Request<awsKinesis.Types.PutRecordsOutput, AWSError>;
17+
};
18+
export default Kinesis;

‎packages/lambda-powertools-kinesis-client/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.24.1",
44
"description": "Kinesis client wrapper that knows how to forward correlation IDs (captured via @dazn/lambda-powertools-correlation-ids)",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"license": "MIT",
78
"author": "Yan Cui",
89
"dependencies": {

0 commit comments

Comments
 (0)