@vyriy/smoke 0.1.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vyriy contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# @vyriy/smoke
+
+Smoke request matcher for Vyriy projects.
+
+## Purpose
+
+This package provides a small helper for recognizing a dedicated smoke request and returning a predefined response without running the main handler logic.
+
+It is intended to be used directly or through packages such as `@vyriy/handler`.
+
+## Install
+
+With npm:
+
+```bash
+npm install @vyriy/smoke
+```
+
+With Yarn:
+
+```bash
+yarn add @vyriy/smoke
+```
+
+## Usage
+
+Use the default smoke request and response:
+
+```ts
+import { smoke } from '@vyriy/smoke';
+
+const result = smoke({ isSmoke: true });
+
+if (result) {
+  return result;
+}
+```
+
+## API
+
+- `request`
+  Default smoke request payload: `{ isSmoke: true }`.
+
+- `response`
+  Default smoke response payload: `{ 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
+- the helper is best suited for small, stable smoke payloads

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './smoke.js';
+export type * from './types.js';

package/index.js

@@ -0,0 +1 @@
+export * from './smoke.js';

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vyriy/smoke",
+  "version": "0.1.9",
+  "description": "Smoke request matcher for short-circuiting handlers in Vyriy projects",
+  "type": "module",
+  "main": "./index.js",
+  "license": "MIT",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./index": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./index.js": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./smoke": {
+      "types": "./smoke.d.ts",
+      "import": "./smoke.js",
+      "default": "./smoke.js"
+    },
+    "./smoke.js": {
+      "types": "./smoke.d.ts",
+      "import": "./smoke.js",
+      "default": "./smoke.js"
+    }
+  }
+}

package/smoke.d.ts

@@ -0,0 +1,4 @@
+import type { Request, Response, Smoke } from './types.js';
+export declare const request: Request;
+export declare const response: Response;
+export declare const smoke: Smoke;

package/smoke.js

@@ -0,0 +1,8 @@
+export const request = { isSmoke: true };
+export const response = { status: 'success' };
+export const smoke = (event) => {
+    if (JSON.stringify(event) === JSON.stringify(request)) {
+        return response;
+    }
+    return false;
+};

package/types.d.ts

@@ -0,0 +1,3 @@
+export type Request = Record<string, unknown>;
+export type Response = Record<string, unknown>;
+export type Smoke = (event: unknown) => Response | false;