@dismissible/nestjs-request 1.0.3-alpha.064e57a.0

package/README.md

@@ -0,0 +1,91 @@
+<p align="center">
+  <a href="https://dismissible.io" target="_blank"><img src="../../docs/images/dismissible_logo.png" width="120" alt="Dismissible" /></a>
+</p>
+
+<p align="center">Never Show The Same Thing Twice!</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/@dismissible/nestjs-request" target="_blank"><img src="https://img.shields.io/npm/v/@dismissible/nestjs-request.svg" alt="NPM Version" /></a>
+  <a href="https://github.com/dismissibleio/dismissible-api/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@dismissible/nestjs-request.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/package/@dismissible/nestjs-request" target="_blank"><img src="https://img.shields.io/npm/dm/@dismissible/nestjs-request.svg" alt="NPM Downloads" /></a>
+  <a href="https://github.com/dismissibleio/dismissible-api" target="_blank"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/dismissibleio/dismissible-api/release.yml"></a>
+  <a href="https://paypal.me/joshstuartx" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
+</p>
+
+Dismissible manages the state of your UI elements across sessions, so your users see what matters, once! No more onboarding messages reappearing on every tab, no more notifications haunting users across devices. Dismissible syncs dismissal state everywhere, so every message is intentional, never repetitive.
+
+# @dismissible/nestjs-request
+
+Request context decorator for Dismissible applications.
+
+> **Part of the Dismissible API** - This library is part of the [Dismissible API](https://dismissible.io) ecosystem. Visit [dismissible.io](https://dismissible.io) for more information and documentation.
+
+## Overview
+
+This library provides a NestJS parameter decorator for extracting request context from HTTP requests:
+
+- `RequestContext` - Parameter decorator that extracts request context from the current HTTP request
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-request
+```
+
+## Getting Started
+
+### Basic Usage
+
+Use the `RequestContext` decorator in your controllers to extract request context:
+
+```typescript
+import { Controller, Get } from '@nestjs/common';
+import { RequestContext, IRequestContext } from '@dismissible/nestjs-request';
+
+@Controller('items')
+export class ItemsController {
+  @Get()
+  async getItems(@RequestContext() context: IRequestContext) {
+    // Use context.requestId, context.headers, etc.
+    return { requestId: context.requestId };
+  }
+}
+```
+
+## API Reference
+
+### RequestContext
+
+A NestJS parameter decorator that extracts request context from the current HTTP request.
+
+The decorator returns an `IRequestContext` object containing:
+
+- `requestId` - Unique request identifier (from `x-request-id` header or generated UUID)
+- `headers` - Request headers
+- `query` - Query parameters
+- `params` - Route parameters
+- `body` - Request body
+- `user` - Authenticated user (if available)
+- `ip` - Client IP address
+- `method` - HTTP method
+- `url` - Request URL
+- `protocol` - Request protocol
+- `secure` - Whether the request is secure (HTTPS)
+- `hostname` - Request hostname
+- `port` - Request port
+- `path` - Request path
+- `search` - Query string
+- `searchParams` - Parsed search parameters
+- `origin` - Request origin
+- `referer` - Referer header
+- `userAgent` - User agent header
+
+## Related Packages
+
+This library is typically used alongside other Dismissible packages:
+
+- `@dismissible/nestjs-hooks` - Provides the `IRequestContext` interface
+- `@dismissible/nestjs-core` - Main dismissible service and module
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@dismissible/nestjs-request",
+  "version": "1.0.3-alpha.064e57a.0",
+  "description": "Request context decorator for Dismissible applications",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "uuid": "13.0.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "10.0.0 || ^11.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    }
+  },
+  "keywords": [
+    "nestjs",
+    "dismissible",
+    "request",
+    "context",
+    "decorator"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DismissibleIo/dismissible-api"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request-context.decorator';
+export * from './request-context.interface';

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./request-context.decorator"), exports);
+tslib_1.__exportStar(require("./request-context.interface"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/request/src/index.ts"],"names":[],"mappings":";;;AAAA,sEAA4C;AAC5C,sEAA4C"}

package/src/request-context.decorator.d.ts

@@ -0,0 +1 @@
+export declare const RequestContext: (...dataOrPipes: unknown[]) => ParameterDecorator;

package/src/request-context.decorator.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContext = void 0;
+const common_1 = require("@nestjs/common");
+const uuid_1 = require("uuid");
+exports.RequestContext = (0, common_1.createParamDecorator)((_data, ctx) => {
+    const request = ctx.switchToHttp().getRequest();
+    const headers = request.headers;
+    return {
+        requestId: headers['x-request-id'] ?? (0, uuid_1.v4)(),
+        headers,
+        query: request.query,
+        params: request.params,
+        body: request.body,
+        user: request.user,
+        ip: request.ip,
+        method: request.method,
+        url: request.url,
+        protocol: request.protocol,
+        secure: request.secure,
+        hostname: request.hostname,
+        port: request.port,
+        path: request.path,
+        search: request.search,
+        searchParams: request.searchParams,
+        origin: request.origin,
+        referer: request.referer,
+        userAgent: request.userAgent,
+    };
+});
+//# sourceMappingURL=request-context.decorator.js.map

package/src/request-context.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.decorator.js","sourceRoot":"","sources":["../../../../libs/request/src/request-context.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AACxE,+BAAoC;AAGvB,QAAA,cAAc,GAAG,IAAA,6BAAoB,EAChD,CAAC,KAAc,EAAE,GAAqB,EAAmB,EAAE;IACzD,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAEhC,OAAO;QACL,SAAS,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,IAAA,SAAM,GAAE;QAC9C,OAAO;QACP,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC;AACJ,CAAC,CACF,CAAC"}

package/src/request-context.interface.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Request context passed through the dismissible operations.
+ */
+export type IRequestContext = {
+    requestId: string;
+    headers: Record<string, string>;
+    query: Record<string, string>;
+    params: Record<string, string>;
+    body: Record<string, string>;
+    user: Record<string, string>;
+    ip: string;
+    method: string;
+    url: string;
+    protocol: string;
+    secure: boolean;
+    hostname: string;
+    port: number;
+    path: string;
+    search: string;
+    searchParams: Record<string, string>;
+    origin: string;
+    referer: string;
+    userAgent: string;
+};

package/src/request-context.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request-context.interface.js.map

package/src/request-context.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.interface.js","sourceRoot":"","sources":["../../../../libs/request/src/request-context.interface.ts"],"names":[],"mappings":""}