@vyriy/smoke 0.2.1 → 0.3.2

package/README.md

@@ -42,13 +42,21 @@ if (result) {
   Default smoke request payload: `{ isSmoke: true }`.
 
 - `response`
-  Default smoke response payload: `{ status: 'success' }`.
+  Default API Gateway-compatible smoke response:
+
+```ts
+{
+  statusCode: 200,
+  body: JSON.stringify({
+    status: 'success',
+  }),
+}
+```
 
 - `smoke(event)`
   Returns the smoke response when `event` matches the smoke request, otherwise returns `false`.
 
 ## Notes
 
-- matching is performed by comparing `JSON.stringify(event)` and `JSON.stringify(request)`
-- if property order differs, objects that are otherwise structurally equal may not match
+- matching checks whether the incoming event is an object with `isSmoke: true`
 - the helper is best suited for small, stable smoke payloads

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vyriy/smoke",
-  "version": "0.2.1",
+  "version": "0.3.2",
   "description": "Smoke request matcher for short-circuiting handlers in Vyriy projects",
   "type": "module",
   "main": "./index.js",

package/smoke.js

@@ -1,7 +1,12 @@
 export const request = { isSmoke: true };
-export const response = { status: 'success' };
+export const response = {
+    statusCode: 200,
+    body: JSON.stringify({
+        status: 'success',
+    }),
+};
 export const smoke = (event) => {
-    if (JSON.stringify(event) === JSON.stringify(request)) {
+    if (typeof event === 'object' && event && 'isSmoke' in event && event.isSmoke === request.isSmoke) {
         return response;
     }
     return false;

package/types.d.ts

@@ -1,3 +1,4 @@
+import type { APIGatewayProxyResult } from 'aws-lambda';
 export type Request = Record<string, unknown>;
-export type Response = Record<string, unknown>;
+export type Response = APIGatewayProxyResult;
 export type Smoke = (event: unknown) => Response | false;