merged

packages/parser/src/parserDecorator.ts

@@ -1,5 +1,5 @@
-import { HandlerMethodDecorator } from '@aws-lambda-powertools/commons/types';
-import { Context, Handler } from 'aws-lambda';
+import type { HandlerMethodDecorator } from '@aws-lambda-powertools/commons/types';
+import type { Context, Handler } from 'aws-lambda';
 import { ZodSchema, z } from 'zod';
 import { parse } from './parser.js';
 import type { ParserOptions, ParsedResult } from './types/index.js';
@@ -10,14 +10,15 @@ import type { ParserOptions, ParsedResult } from './types/index.js';
  * @example
  * ```typescript
  *
+ * import type { SqSEvent } from '@aws-lambda-powertools/parser/types;
  * import { parser } from '@aws-lambda-powertools/parser';
- * import { SqsEnvelope } from '@aws-lambda-powertools/parser/envelopes/';
- * import types { SqSEvent } from '@aws-lambda-powertools/parser/types;
+ * import { z } from 'zod';
+ * import { SqsEnvelope } from '@aws-lambda-powertools/parser/envelopes';
  *
  *
  * const Order = z.object({
- *  orderId: z.string(),
- *  description: z.string(),
+ *   orderId: z.string(),
+ *   description: z.string(),
  * }
  *
  * class Lambda extends LambdaInterface {
@@ -39,14 +40,16 @@ import type { ParserOptions, ParsedResult } from './types/index.js';
  * @example
  * ```typescript
  *
+ * import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
+ * import type { SqSEvent, ParsedResult } from '@aws-lambda-powertools/parser/types;
+ * import { z } from 'zod';
  * import { parser } from '@aws-lambda-powertools/parser';
- * import { SqsEnvelope } from '@aws-lambda-powertools/parser/envelopes/';
- * import types { SqSEvent, ParsedResult } from '@aws-lambda-powertools/parser/types;
+ * import { SqsEnvelope } from '@aws-lambda-powertools/parser/envelopes';
  *
  *
  * const Order = z.object({
- *  orderId: z.string(),
- *  description: z.string(),
+ *   orderId: z.string(),
+ *   description: z.string(),
  * }
  *
  * class Lambda extends LambdaInterface {

packages/parser/src/types/envelope.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   ApiGatewayEnvelope,
   KinesisFirehoseEnvelope,
   KinesisEnvelope,
@@ -16,17 +16,17 @@ import {
 } from '../envelopes/index.js';
 
 export type Envelope =
-  | typeof ApiGatewayEnvelope
-  | typeof ApiGatewayV2Envelope
-  | typeof CloudWatchEnvelope
-  | typeof DynamoDBStreamEnvelope
-  | typeof EventBridgeEnvelope
-  | typeof KafkaEnvelope
-  | typeof KinesisEnvelope
-  | typeof KinesisFirehoseEnvelope
-  | typeof LambdaFunctionUrlEnvelope
-  | typeof SnsEnvelope
-  | typeof SnsSqsEnvelope
-  | typeof SqsEnvelope
-  | typeof VpcLatticeEnvelope
-  | typeof VpcLatticeV2Envelope;
+  | ApiGatewayEnvelope
+  | ApiGatewayV2Envelope
+  | CloudWatchEnvelope
+  | DynamoDBStreamEnvelope
+  | EventBridgeEnvelope
+  | KafkaEnvelope
+  | KinesisEnvelope
+  | KinesisFirehoseEnvelope
+  | LambdaFunctionUrlEnvelope
+  | SnsEnvelope
+  | SnsSqsEnvelope
+  | SqsEnvelope
+  | VpcLatticeEnvelope
+  | VpcLatticeV2Envelope;

packages/parser/src/types/parser.ts

@@ -1,23 +1,30 @@
-import { ZodSchema, ZodError } from 'zod';
-import { Envelope } from './envelope.js';
+import type { ZodSchema, ZodError } from 'zod';
+import type { Envelope } from './envelope.js';
 
-export type ParserOptions<S extends ZodSchema> = {
+type ParserOptions<S extends ZodSchema> = {
   schema: S;
   envelope?: Envelope;
   safeParse?: boolean;
 };
 
-export type ParsedResultSuccess<Output> = {
+type ParsedResultSuccess<Output> = {
   success: true;
   data: Output;
 };
 
-export type ParsedResultError<Input> = {
+type ParsedResultError<Input> = {
   success: false;
   error: ZodError | Error;
   originalEvent: Input;
 };
 
-export type ParsedResult<Input = unknown, Output = unknown> =
+type ParsedResult<Input = unknown, Output = unknown> =
   | ParsedResultSuccess<Output>
   | ParsedResultError<Input>;
+
+export type {
+  ParserOptions,
+  ParsedResult,
+  ParsedResultError,
+  ParsedResultSuccess,
+};