chore(parser): add parser subpath exports to package.json (#2179)

* add exports and type version to package json, including index.js * use index.js as import for coverage * use package lock from main * fix envelope path and add types to exports * use explicit exports instead of * * import type * make export types explicit * adjust imports in tests for coverage, removed unused exports * remove duplicate imports
aws-powertools · Mar 11, 2024 · b348b95 · b348b95
1 parent a9f5d79
commit b348b95
Show file tree

Hide file tree

Showing 39 changed files with 4,029 additions and 2,366 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/parser/package.json b/packages/parser/package.json
@@ -37,6 +37,42 @@
         "types": "./lib/esm/index.d.ts",
         "default": "./lib/esm/index.js"
       }
+    },
+    "./middleware": {
+      "require": "./lib/cjs/middleware/parser.js",
+      "import": "./lib/esm/middleware/parser.js"
+    },
+    "./schemas": {
+      "require": "./lib/cjs/schemas/index.js",
+      "import": "./lib/esm/schemas/index.js"
+    },
+    "./envelopes": {
+      "require": "./lib/cjs/envelopes/index.js",
+      "import": "./lib/esm/envelopes/index.js"
+    },
+    "./types": {
+      "require": "./lib/cjs/types/index.js",
+      "import": "./lib/esm/types/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./lib/cjs/types/index.d.ts",
+        "./lib/esm/types/index.d.ts"
+      ],
+      "middleware": [
+        "./lib/cjs/middleware/parser.d.ts",
+        "./lib/esm/middleware/parser.d.ts"
+      ],
+      "schemas": [
+        "./lib/cjs/schemas/index.d.ts",
+        "./lib/esm/schemas/index.d.ts"
+      ],
+      "envelopes": [
+        "./lib/cjs/envelopes/index.d.ts",
+        "./lib/esm/envelopes/index.d.ts"
+      ]
     }
   },
   "main": "./lib/cjs/index.js",

diff --git a/packages/parser/src/envelopes/index.ts b/packages/parser/src/envelopes/index.ts
@@ -0,0 +1,13 @@
+export { apiGatewayEnvelope } from './apigw.js';
+export { apiGatewayV2Envelope } from './apigwv2.js';
+export { cloudWatchEnvelope } from './cloudwatch.js';
+export { dynamoDDStreamEnvelope } from './dynamodb.js';
+export { eventBridgeEnvelope } from './event-bridge.js';
+export { kafkaEnvelope } from './kafka.js';
+export { kinesisEnvelope } from './kinesis.js';
+export { kinesisFirehoseEnvelope } from './kinesis-firehose.js';
+export { lambdaFunctionUrlEnvelope } from './lambda.js';
+export { snsEnvelope, snsSqsEnvelope } from './sns.js';
+export { sqsEnvelope } from './sqs.js';
+export { vpcLatticeEnvelope } from './vpc-lattice.js';
+export { vpcLatticeV2Envelope } from './vpc-latticev2.js';
diff --git a/packages/parser/src/index.ts b/packages/parser/src/index.ts
@@ -0,0 +1 @@
+export { parser } from './parser.js';
diff --git a/packages/parser/src/parser.ts b/packages/parser/src/parser.ts
@@ -31,7 +31,7 @@ import { type ParserOptions } from './types/ParserOptions.js';
  *
  * @param options
  */
-const parser = <S extends ZodSchema>(
+export const parser = <S extends ZodSchema>(
   options: ParserOptions<S>
 ): HandlerMethodDecorator => {
   return (_target, _propertyKey, descriptor) => {
@@ -55,5 +55,3 @@ const parser = <S extends ZodSchema>(
     return descriptor;
   };
 };
-
-export { parser };
diff --git a/packages/parser/src/schemas/index.ts b/packages/parser/src/schemas/index.ts
@@ -0,0 +1,33 @@
+export { AlbSchema, AlbMultiValueHeadersSchema } from './alb.js';
+export { APIGatewayProxyEventSchema } from './apigw.js';
+export { APIGatewayProxyEventV2Schema } from './apigwv2.js';
+export {
+  CloudFormationCustomResourceCreateSchema,
+  CloudFormationCustomResourceDeleteSchema,
+  CloudFormationCustomResourceUpdateSchema,
+} from './cloudformation-custom-resource.js';
+export {
+  CloudWatchLogEventSchema,
+  CloudWatchLogsDecodeSchema,
+  CloudWatchLogsSchema,
+} from './cloudwatch.js';
+export { DynamoDBStreamSchema } from './dynamodb.js';
+export { EventBridgeSchema } from './eventbridge.js';
+export { KafkaMskEventSchema, KafkaSelfManagedEventSchema } from './kafka.js';
+export { KinesisDataStreamSchema } from './kinesis.js';
+export {
+  KinesisFirehoseSchema,
+  KinesisFirehoseSqsSchema,
+} from './kinesis-firehose.js';
+export { LambdaFunctionUrlSchema } from './lambda.js';
+export {
+  S3SqsEventNotificationSchema,
+  S3EventNotificationEventBridgeSchema,
+  S3ObjectLambdaEventSchema,
+  S3Schema,
+} from './s3.js';
+export { SesSchema } from './ses.js';
+export { SnsSchema } from './sns.js';
+export { SqsSchema } from './sqs.js';
+export { VpcLatticeSchema } from './vpc-lattice.js';
+export { VpcLatticeV2Schema } from './vpc-latticev2.js';
diff --git a/packages/parser/src/types/ParserOptions.ts b/packages/parser/src/types/ParserOptions.ts
@@ -1,9 +1,7 @@
 import type { ZodSchema } from 'zod';
 import { Envelope } from './envelope.js';
 
-type ParserOptions<S extends ZodSchema> = {
+export type ParserOptions<S extends ZodSchema> = {
   schema: S;
   envelope?: Envelope;
 };
-
-export { type ParserOptions };
diff --git a/packages/parser/src/types/index.ts b/packages/parser/src/types/index.ts
@@ -0,0 +1,31 @@
+export type { ParserOptions } from './ParserOptions.js';
+export type { Envelope } from './envelope.js';
+
+export type {
+  ALBEvent,
+  APIGatewayProxyEvent,
+  ALBMultiValueHeadersEvent,
+  APIGatewayProxyEventV2,
+  S3Event,
+  S3EventNotificationEventBridge,
+  S3SqsEventNotification,
+  SnsEvent,
+  SqsEvent,
+  DynamoDBStreamEvent,
+  CloudWatchLogsEvent,
+  CloudFormationCustomResourceCreateEvent,
+  CloudFormationCustomResourceDeleteEvent,
+  CloudFormationCustomResourceUpdateEvent,
+  EventBridgeEvent,
+  KafkaSelfManagedEvent,
+  KafkaMskEvent,
+  KinesisDataStreamEvent,
+  KinesisDataStreamRecord,
+  KinesisDataStreamRecordPayload,
+  KinesisFireHoseEvent,
+  KinesisFireHoseSqsEvent,
+  LambdaFunctionUrlEvent,
+  SesEvent,
+  VpcLatticeEvent,
+  VpcLatticeEventV2,
+} from './schema.js';
diff --git a/packages/parser/tests/unit/envelopes/apigwt.test.ts b/packages/parser/tests/unit/envelopes/apigwt.test.ts
@@ -6,8 +6,8 @@
 
 import { generateMock } from '@anatine/zod-mock';
 import { TestEvents, TestSchema } from '../schema/utils.js';
-import { APIGatewayProxyEvent } from '../../../src/types/schema.js';
-import { apiGatewayEnvelope } from '../../../src/envelopes/apigw';
+import { APIGatewayProxyEvent } from '../../../src/types/';
+import { apiGatewayEnvelope } from '../../../src/envelopes/';
 
 describe('ApigwEnvelope ', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/apigwv2.test.ts b/packages/parser/tests/unit/envelopes/apigwv2.test.ts
@@ -7,7 +7,7 @@
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { generateMock } from '@anatine/zod-mock';
 import { APIGatewayProxyEventV2 } from 'aws-lambda';
-import { apiGatewayV2Envelope } from '../../../src/envelopes/apigwv2';
+import { apiGatewayV2Envelope } from '../../../src/envelopes/';
 
 describe('ApiGwV2Envelope ', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/cloudwatch.test.ts b/packages/parser/tests/unit/envelopes/cloudwatch.test.ts
@@ -9,9 +9,9 @@ import { gzipSync } from 'node:zlib';
 import {
   CloudWatchLogEventSchema,
   CloudWatchLogsDecodeSchema,
-} from '../../../src/schemas/cloudwatch.js';
+} from '../../../src/schemas/';
 import { TestSchema } from '../schema/utils.js';
-import { cloudWatchEnvelope } from '../../../src/envelopes/cloudwatch';
+import { cloudWatchEnvelope } from '../../../src/envelopes/';
 
 describe('CloudWatch', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/dynamodb.test.ts b/packages/parser/tests/unit/envelopes/dynamodb.test.ts
@@ -8,7 +8,7 @@ import { generateMock } from '@anatine/zod-mock';
 import { TestEvents } from '../schema/utils.js';
 import { DynamoDBStreamEvent } from 'aws-lambda';
 import { z } from 'zod';
-import { dynamoDDStreamEnvelope } from '../../../src/envelopes/dynamodb';
+import { dynamoDDStreamEnvelope } from '../../../src/envelopes/';
 
 describe('DynamoDB', () => {
   const schema = z.object({

diff --git a/packages/parser/tests/unit/envelopes/eventbridge.test.ts b/packages/parser/tests/unit/envelopes/eventbridge.test.ts
@@ -7,7 +7,7 @@
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { generateMock } from '@anatine/zod-mock';
 import { EventBridgeEvent } from 'aws-lambda';
-import { eventBridgeEnvelope } from '../../../src/envelopes/event-bridge.js';
+import { eventBridgeEnvelope } from '../../../src/envelopes/';
 
 describe('EventBridgeEnvelope ', () => {
   it('should parse eventbridge event', () => {

diff --git a/packages/parser/tests/unit/envelopes/kafka.test.ts b/packages/parser/tests/unit/envelopes/kafka.test.ts
@@ -7,7 +7,7 @@
 import { generateMock } from '@anatine/zod-mock';
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { MSKEvent, SelfManagedKafkaEvent } from 'aws-lambda';
-import { kafkaEnvelope } from '../../../src/envelopes/kafka';
+import { kafkaEnvelope } from '../../../src/envelopes/';
 
 describe('Kafka', () => {
   it('should parse MSK kafka envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/kinesis-firehose.test.ts b/packages/parser/tests/unit/envelopes/kinesis-firehose.test.ts
@@ -6,9 +6,9 @@
 
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { generateMock } from '@anatine/zod-mock';
-import { KinesisFirehoseSchema } from '../../../src/schemas/kinesis-firehose.js';
+import { KinesisFirehoseSchema } from '../../../src/schemas/';
 import { z } from 'zod';
-import { kinesisFirehoseEnvelope } from '../../../src/envelopes/kinesis-firehose';
+import { kinesisFirehoseEnvelope } from '../../../src/envelopes/';
 
 describe('Kinesis Firehose Envelope', () => {
   it('should parse records for PutEvent', () => {

diff --git a/packages/parser/tests/unit/envelopes/kinesis.test.ts b/packages/parser/tests/unit/envelopes/kinesis.test.ts
@@ -7,7 +7,7 @@
 import { generateMock } from '@anatine/zod-mock';
 import { KinesisStreamEvent } from 'aws-lambda';
 import { TestEvents, TestSchema } from '../schema/utils.js';
-import { kinesisEnvelope } from '../../../src/envelopes/kinesis';
+import { kinesisEnvelope } from '../../../src/envelopes/';
 
 describe('Kinesis', () => {
   it('should parse Kinesis Stream event', () => {

diff --git a/packages/parser/tests/unit/envelopes/lambda.test.ts b/packages/parser/tests/unit/envelopes/lambda.test.ts
@@ -7,7 +7,7 @@
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { generateMock } from '@anatine/zod-mock';
 import { APIGatewayProxyEventV2 } from 'aws-lambda';
-import { lambdaFunctionUrlEnvelope } from '../../../src/envelopes/lambda';
+import { lambdaFunctionUrlEnvelope } from '../../../src/envelopes/';
 
 describe('Lambda Functions Url ', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/sns.test.ts b/packages/parser/tests/unit/envelopes/sns.test.ts
@@ -8,7 +8,7 @@ import { z } from 'zod';
 import { generateMock } from '@anatine/zod-mock';
 import { SNSEvent, SQSEvent } from 'aws-lambda';
 import { TestEvents, TestSchema } from '../schema/utils.js';
-import { snsEnvelope, snsSqsEnvelope } from '../../../src/envelopes/sns';
+import { snsEnvelope, snsSqsEnvelope } from '../../../src/envelopes/';
 
 describe('SNS Envelope', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/sqs.test.ts b/packages/parser/tests/unit/envelopes/sqs.test.ts
@@ -7,7 +7,7 @@
 import { generateMock } from '@anatine/zod-mock';
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { SQSEvent } from 'aws-lambda';
-import { sqsEnvelope } from '../../../src/envelopes/sqs';
+import { sqsEnvelope } from '../../../src/envelopes/';
 
 describe('SqsEnvelope ', () => {
   it('should parse custom schema in envelope', () => {

diff --git a/packages/parser/tests/unit/envelopes/vpc-lattice.test.ts b/packages/parser/tests/unit/envelopes/vpc-lattice.test.ts
@@ -6,9 +6,9 @@
 
 import { generateMock } from '@anatine/zod-mock';
 import { TestEvents, TestSchema } from '../schema/utils.js';
-import { VpcLatticeSchema } from '../../../src/schemas/vpc-lattice.js';
+import { VpcLatticeSchema } from '../../../src/schemas/';
 import { z } from 'zod';
-import { vpcLatticeEnvelope } from '../../../src/envelopes/vpc-lattice';
+import { vpcLatticeEnvelope } from '../../../src/envelopes/';
 
 describe('VPC Lattice envelope', () => {
   it('should parse VPC Lattice event', () => {

diff --git a/packages/parser/tests/unit/envelopes/vpc-latticev2.test.ts b/packages/parser/tests/unit/envelopes/vpc-latticev2.test.ts
@@ -5,10 +5,10 @@
  */
 
 import { generateMock } from '@anatine/zod-mock';
-import { VpcLatticeSchema } from '../../../src/schemas/vpc-lattice.js';
+import { VpcLatticeSchema } from '../../../src/schemas/';
 import { z } from 'zod';
 import { TestEvents, TestSchema } from '../schema/utils.js';
-import { vpcLatticeV2Envelope } from '../../../src/envelopes/vpc-latticev2';
+import { vpcLatticeV2Envelope } from '../../../src/envelopes/';
 
 describe('VPC Lattice envelope', () => {
   it('should parse VPC Lattice event', () => {

diff --git a/packages/parser/tests/unit/parser.decorator.test.ts b/packages/parser/tests/unit/parser.decorator.test.ts
@@ -4,13 +4,13 @@
  * @group unit/parser
  */
 
-import { LambdaInterface } from '@aws-lambda-powertools/commons/lib/esm/types';
+import type { LambdaInterface } from '@aws-lambda-powertools/commons/lib/esm/types';
 import { Context, EventBridgeEvent } from 'aws-lambda';
-import { parser } from '../../src/parser';
+import { parser } from '../../src/index.js';
 import { TestSchema, TestEvents } from './schema/utils';
 import { generateMock } from '@anatine/zod-mock';
-import { eventBridgeEnvelope } from '../../src/envelopes/event-bridge';
-import { EventBridgeSchema } from '../../src/schemas/eventbridge';
+import { eventBridgeEnvelope } from '../../src/envelopes/index.js';
+import { EventBridgeSchema } from '../../src/schemas/index.js';
 import { z } from 'zod';
 
 describe('Parser Decorator', () => {

diff --git a/packages/parser/tests/unit/parser.middy.test.ts b/packages/parser/tests/unit/parser.middy.test.ts
@@ -8,9 +8,9 @@ import middy from '@middy/core';
 import { Context } from 'aws-lambda';
 import { parser } from '../../src/middleware/parser.js';
 import { generateMock } from '@anatine/zod-mock';
-import { SqsSchema } from '../../src/schemas/sqs.js';
+import { SqsSchema } from '../../src/schemas/index.js';
 import { z, type ZodSchema } from 'zod';
-import { sqsEnvelope } from '../../src/envelopes/sqs';
+import { sqsEnvelope } from '../../src/envelopes/index.js';
 import { TestSchema } from './schema/utils';
 
 describe('Middleware: parser', () => {

diff --git a/packages/parser/tests/unit/schema/alb.test.ts b/packages/parser/tests/unit/schema/alb.test.ts
@@ -3,10 +3,7 @@
  *
  * @group unit/parser/schema/
  */
-import {
-  AlbSchema,
-  AlbMultiValueHeadersSchema,
-} from '../../../src/schemas/alb.js';
+import { AlbSchema, AlbMultiValueHeadersSchema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('ALB ', () => {

diff --git a/packages/parser/tests/unit/schema/apigw.test.ts b/packages/parser/tests/unit/schema/apigw.test.ts
@@ -4,7 +4,7 @@
  * @group unit/parser/schema/
  */
 
-import { APIGatewayProxyEventSchema } from '../../../src/schemas/apigw.js';
+import { APIGatewayProxyEventSchema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('APIGateway ', () => {

diff --git a/packages/parser/tests/unit/schema/apigwv2.test.ts b/packages/parser/tests/unit/schema/apigwv2.test.ts
@@ -4,7 +4,7 @@
  * @group unit/parser/schema/
  */
 
-import { APIGatewayProxyEventV2Schema } from '../../../src/schemas/apigwv2.js';
+import { APIGatewayProxyEventV2Schema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('API GW v2 ', () => {

diff --git a/packages/parser/tests/unit/schema/cloudformation-custom-resource.test.ts b/packages/parser/tests/unit/schema/cloudformation-custom-resource.test.ts
@@ -8,7 +8,7 @@ import {
   CloudFormationCustomResourceCreateSchema,
   CloudFormationCustomResourceUpdateSchema,
   CloudFormationCustomResourceDeleteSchema,
-} from '../../../src/schemas/cloudformation-custom-resource.js';
+} from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('CloudFormationCustomResource ', () => {

diff --git a/packages/parser/tests/unit/schema/cloudwatch.test.ts b/packages/parser/tests/unit/schema/cloudwatch.test.ts
@@ -4,7 +4,7 @@
  * @group unit/parser/schema/
  */
 
-import { CloudWatchLogsSchema } from '../../../src/schemas/cloudwatch.js';
+import { CloudWatchLogsSchema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('CloudWatchLogs ', () => {

diff --git a/packages/parser/tests/unit/schema/dynamodb.test.ts b/packages/parser/tests/unit/schema/dynamodb.test.ts
@@ -4,7 +4,7 @@
  * @group unit/parser/schema/
  */
 
-import { DynamoDBStreamSchema } from '../../../src/schemas/dynamodb.js';
+import { DynamoDBStreamSchema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('DynamoDB ', () => {

diff --git a/packages/parser/tests/unit/schema/eventbridge.test.ts b/packages/parser/tests/unit/schema/eventbridge.test.ts
@@ -4,7 +4,7 @@
  * @group unit/parser/schema/
  */
 
-import { EventBridgeSchema } from '../../../src/schemas/eventbridge.js';
+import { EventBridgeSchema } from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('EventBridge ', () => {

diff --git a/packages/parser/tests/unit/schema/kafka.test.ts b/packages/parser/tests/unit/schema/kafka.test.ts
@@ -7,7 +7,7 @@
 import {
   KafkaMskEventSchema,
   KafkaSelfManagedEventSchema,
-} from '../../../src/schemas/kafka.js';
+} from '../../../src/schemas/';
 import { TestEvents } from './utils.js';
 
 describe('Kafka ', () => {