@nestjs-ssr/react 0.2.0 → 0.2.2

package/dist/client.js

@@ -0,0 +1,207 @@
+'use strict';
+
+var React = require('react');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var React__default = /*#__PURE__*/_interopDefault(React);
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var PageContext = /* @__PURE__ */ React.createContext(null);
+function PageContextProvider({ context, children }) {
+  return /* @__PURE__ */ React__default.default.createElement(PageContext.Provider, {
+    value: context
+  }, children);
+}
+__name(PageContextProvider, "PageContextProvider");
+function createSSRHooks() {
+  return {
+    /**
+    * Hook to access the full page context with your app's type.
+    * Contains URL metadata, headers, and any custom properties you've added.
+    */
+    usePageContext: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("usePageContext must be used within PageContextProvider");
+      }
+      return context;
+    }, "usePageContext"),
+    /**
+    * Hook to access route parameters.
+    *
+    * @example
+    * ```tsx
+    * // Route: /users/:id
+    * const params = useParams();
+    * console.log(params.id); // '123'
+    * ```
+    */
+    useParams: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useParams must be used within PageContextProvider");
+      }
+      return context.params;
+    }, "useParams"),
+    /**
+    * Hook to access query string parameters.
+    *
+    * @example
+    * ```tsx
+    * // URL: /search?q=react&sort=date
+    * const query = useQuery();
+    * console.log(query.q);    // 'react'
+    * console.log(query.sort); // 'date'
+    * ```
+    */
+    useQuery: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useQuery must be used within PageContextProvider");
+      }
+      return context.query;
+    }, "useQuery"),
+    /**
+    * Alias for usePageContext() with a more intuitive name.
+    * Returns the full request context with your app's type.
+    *
+    * @example
+    * ```tsx
+    * const request = useRequest();
+    * console.log(request.path);   // '/users/123'
+    * console.log(request.method); // 'GET'
+    * console.log(request.params); // { id: '123' }
+    * console.log(request.query);  // { search: 'foo' }
+    * ```
+    */
+    useRequest: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useRequest must be used within PageContextProvider");
+      }
+      return context;
+    }, "useRequest"),
+    /**
+    * Hook to access headers configured via allowedHeaders.
+    * Returns all headers as a Record.
+    *
+    * Configure in module registration:
+    * ```typescript
+    * RenderModule.register({
+    *   allowedHeaders: ['user-agent', 'x-tenant-id', 'x-api-version']
+    * })
+    * ```
+    *
+    * @example
+    * ```tsx
+    * const headers = useHeaders();
+    * console.log(headers['user-agent']); // 'Mozilla/5.0...'
+    * console.log(headers['x-tenant-id']); // 'tenant-123'
+    * console.log(headers['x-api-version']); // 'v2'
+    * ```
+    */
+    useHeaders: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useHeaders must be used within PageContextProvider");
+      }
+      const baseKeys = /* @__PURE__ */ new Set([
+        "url",
+        "path",
+        "query",
+        "params",
+        "method",
+        "cookies"
+      ]);
+      const headers = {};
+      for (const [key, value] of Object.entries(context)) {
+        if (!baseKeys.has(key) && typeof value === "string") {
+          headers[key] = value;
+        }
+      }
+      return headers;
+    }, "useHeaders"),
+    /**
+    * Hook to access a specific custom header by name.
+    * Returns undefined if the header is not configured or not present.
+    *
+    * @param name - The header name (as configured in allowedHeaders)
+    *
+    * @example
+    * ```tsx
+    * const tenantId = useHeader('x-tenant-id');
+    * if (tenantId) {
+    *   console.log(`Tenant: ${tenantId}`);
+    * }
+    * ```
+    */
+    useHeader: /* @__PURE__ */ __name((name) => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useHeader must be used within PageContextProvider");
+      }
+      const value = context[name];
+      return typeof value === "string" ? value : void 0;
+    }, "useHeader"),
+    /**
+    * Hook to access cookies configured via allowedCookies.
+    * Returns all allowed cookies as a Record.
+    *
+    * Configure in module registration:
+    * ```typescript
+    * RenderModule.register({
+    *   allowedCookies: ['theme', 'locale', 'consent']
+    * })
+    * ```
+    *
+    * @example
+    * ```tsx
+    * const cookies = useCookies();
+    * console.log(cookies.theme);  // 'dark'
+    * console.log(cookies.locale); // 'en-US'
+    * ```
+    */
+    useCookies: /* @__PURE__ */ __name(() => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useCookies must be used within PageContextProvider");
+      }
+      const cookies = context.cookies;
+      return typeof cookies === "object" && cookies !== null ? cookies : {};
+    }, "useCookies"),
+    /**
+    * Hook to access a specific cookie by name.
+    * Returns undefined if the cookie is not configured or not present.
+    *
+    * @param name - The cookie name (as configured in allowedCookies)
+    *
+    * @example
+    * ```tsx
+    * const theme = useCookie('theme');
+    * if (theme === 'dark') {
+    *   console.log('Dark mode enabled');
+    * }
+    * ```
+    */
+    useCookie: /* @__PURE__ */ __name((name) => {
+      const context = React.useContext(PageContext);
+      if (!context) {
+        throw new Error("useCookie must be used within PageContextProvider");
+      }
+      const contextObj = context;
+      const cookies = contextObj.cookies;
+      if (typeof cookies === "object" && cookies !== null && !Array.isArray(cookies)) {
+        const cookiesRecord = cookies;
+        const value = cookiesRecord[name];
+        return typeof value === "string" ? value : void 0;
+      }
+      return void 0;
+    }, "useCookie")
+  };
+}
+__name(createSSRHooks, "createSSRHooks");
+
+exports.PageContextProvider = PageContextProvider;
+exports.createSSRHooks = createSSRHooks;

package/dist/client.mjs

@@ -0,0 +1,200 @@
+import React, { createContext, useContext } from 'react';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var PageContext = /* @__PURE__ */ createContext(null);
+function PageContextProvider({ context, children }) {
+  return /* @__PURE__ */ React.createElement(PageContext.Provider, {
+    value: context
+  }, children);
+}
+__name(PageContextProvider, "PageContextProvider");
+function createSSRHooks() {
+  return {
+    /**
+    * Hook to access the full page context with your app's type.
+    * Contains URL metadata, headers, and any custom properties you've added.
+    */
+    usePageContext: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("usePageContext must be used within PageContextProvider");
+      }
+      return context;
+    }, "usePageContext"),
+    /**
+    * Hook to access route parameters.
+    *
+    * @example
+    * ```tsx
+    * // Route: /users/:id
+    * const params = useParams();
+    * console.log(params.id); // '123'
+    * ```
+    */
+    useParams: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useParams must be used within PageContextProvider");
+      }
+      return context.params;
+    }, "useParams"),
+    /**
+    * Hook to access query string parameters.
+    *
+    * @example
+    * ```tsx
+    * // URL: /search?q=react&sort=date
+    * const query = useQuery();
+    * console.log(query.q);    // 'react'
+    * console.log(query.sort); // 'date'
+    * ```
+    */
+    useQuery: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useQuery must be used within PageContextProvider");
+      }
+      return context.query;
+    }, "useQuery"),
+    /**
+    * Alias for usePageContext() with a more intuitive name.
+    * Returns the full request context with your app's type.
+    *
+    * @example
+    * ```tsx
+    * const request = useRequest();
+    * console.log(request.path);   // '/users/123'
+    * console.log(request.method); // 'GET'
+    * console.log(request.params); // { id: '123' }
+    * console.log(request.query);  // { search: 'foo' }
+    * ```
+    */
+    useRequest: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useRequest must be used within PageContextProvider");
+      }
+      return context;
+    }, "useRequest"),
+    /**
+    * Hook to access headers configured via allowedHeaders.
+    * Returns all headers as a Record.
+    *
+    * Configure in module registration:
+    * ```typescript
+    * RenderModule.register({
+    *   allowedHeaders: ['user-agent', 'x-tenant-id', 'x-api-version']
+    * })
+    * ```
+    *
+    * @example
+    * ```tsx
+    * const headers = useHeaders();
+    * console.log(headers['user-agent']); // 'Mozilla/5.0...'
+    * console.log(headers['x-tenant-id']); // 'tenant-123'
+    * console.log(headers['x-api-version']); // 'v2'
+    * ```
+    */
+    useHeaders: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useHeaders must be used within PageContextProvider");
+      }
+      const baseKeys = /* @__PURE__ */ new Set([
+        "url",
+        "path",
+        "query",
+        "params",
+        "method",
+        "cookies"
+      ]);
+      const headers = {};
+      for (const [key, value] of Object.entries(context)) {
+        if (!baseKeys.has(key) && typeof value === "string") {
+          headers[key] = value;
+        }
+      }
+      return headers;
+    }, "useHeaders"),
+    /**
+    * Hook to access a specific custom header by name.
+    * Returns undefined if the header is not configured or not present.
+    *
+    * @param name - The header name (as configured in allowedHeaders)
+    *
+    * @example
+    * ```tsx
+    * const tenantId = useHeader('x-tenant-id');
+    * if (tenantId) {
+    *   console.log(`Tenant: ${tenantId}`);
+    * }
+    * ```
+    */
+    useHeader: /* @__PURE__ */ __name((name) => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useHeader must be used within PageContextProvider");
+      }
+      const value = context[name];
+      return typeof value === "string" ? value : void 0;
+    }, "useHeader"),
+    /**
+    * Hook to access cookies configured via allowedCookies.
+    * Returns all allowed cookies as a Record.
+    *
+    * Configure in module registration:
+    * ```typescript
+    * RenderModule.register({
+    *   allowedCookies: ['theme', 'locale', 'consent']
+    * })
+    * ```
+    *
+    * @example
+    * ```tsx
+    * const cookies = useCookies();
+    * console.log(cookies.theme);  // 'dark'
+    * console.log(cookies.locale); // 'en-US'
+    * ```
+    */
+    useCookies: /* @__PURE__ */ __name(() => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useCookies must be used within PageContextProvider");
+      }
+      const cookies = context.cookies;
+      return typeof cookies === "object" && cookies !== null ? cookies : {};
+    }, "useCookies"),
+    /**
+    * Hook to access a specific cookie by name.
+    * Returns undefined if the cookie is not configured or not present.
+    *
+    * @param name - The cookie name (as configured in allowedCookies)
+    *
+    * @example
+    * ```tsx
+    * const theme = useCookie('theme');
+    * if (theme === 'dark') {
+    *   console.log('Dark mode enabled');
+    * }
+    * ```
+    */
+    useCookie: /* @__PURE__ */ __name((name) => {
+      const context = useContext(PageContext);
+      if (!context) {
+        throw new Error("useCookie must be used within PageContextProvider");
+      }
+      const contextObj = context;
+      const cookies = contextObj.cookies;
+      if (typeof cookies === "object" && cookies !== null && !Array.isArray(cookies)) {
+        const cookiesRecord = cookies;
+        const value = cookiesRecord[name];
+        return typeof value === "string" ? value : void 0;
+      }
+      return void 0;
+    }, "useCookie")
+  };
+}
+__name(createSSRHooks, "createSSRHooks");
+
+export { PageContextProvider, createSSRHooks };

package/dist/{index-C5Knql-9.d.mts → index-CaGD266H.d.ts}

@@ -1,114 +1,12 @@
 import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
 import { ComponentType } from 'react';
+import { H as HeadData } from './render-response.interface-Dc-Kwb09.js';
 import { ViteDevServer } from 'vite';
 import { Response } from 'express';
 import { Reflector } from '@nestjs/core';
 import { Observable } from 'rxjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
-/**
- * HTML head data for SEO and page metadata
- */
-interface HeadData {
-    /** Page title (appears in browser tab and search results) */
-    title?: string;
-    /** Page description for search engines */
-    description?: string;
-    /** Page keywords (legacy, less important for modern SEO) */
-    keywords?: string;
-    /** Canonical URL for duplicate content */
-    canonical?: string;
-    /** Open Graph title for social media sharing */
-    ogTitle?: string;
-    /** Open Graph description for social media sharing */
-    ogDescription?: string;
-    /** Open Graph image URL for social media previews */
-    ogImage?: string;
-    /** Additional link tags (fonts, icons, preloads, etc.) */
-    links?: Array<{
-        rel: string;
-        href: string;
-        as?: string;
-        type?: string;
-        crossorigin?: string;
-        [key: string]: any;
-    }>;
-    /** Additional meta tags */
-    meta?: Array<{
-        name?: string;
-        property?: string;
-        content: string;
-        [key: string]: any;
-    }>;
-    /** Script tags for analytics, tracking, etc. */
-    scripts?: Array<{
-        src?: string;
-        async?: boolean;
-        defer?: boolean;
-        type?: string;
-        innerHTML?: string;
-        [key: string]: any;
-    }>;
-    /** JSON-LD structured data for search engines */
-    jsonLd?: Array<Record<string, any>>;
-    /** Attributes to add to <html> tag (e.g., lang, dir) */
-    htmlAttributes?: Record<string, string>;
-    /** Attributes to add to <body> tag (e.g., class, data-theme) */
-    bodyAttributes?: Record<string, string>;
-}
-/**
- * Response structure for SSR rendering
- *
- * Can be returned from controllers decorated with @Render.
- * For backwards compatibility, controllers can also return plain objects
- * which will be auto-wrapped as { props: data }.
- *
- * @example
- * ```typescript
- * // Simple case - just props (auto-wrapped)
- * @Render('views/home')
- * getHome() {
- *   return { message: 'Hello' };
- *   // Treated as: { props: { message: 'Hello' } }
- * }
- *
- * // Advanced case - with head data and layout props
- * @Render('views/user')
- * getUser(@Param('id') id: string) {
- *   const user = await this.userService.findOne(id);
- *   return {
- *     props: { user },
- *     layoutProps: {
- *       title: user.name,
- *       subtitle: 'User Profile'
- *     },
- *     head: {
- *       title: `${user.name} - Profile`,
- *       description: user.bio,
- *       ogImage: user.avatar
- *     }
- *   };
- * }
- * ```
- */
-interface RenderResponse<T = any> {
-    /** Props passed to the React component */
-    props: T;
-    /** HTML head data (title, meta tags, links) */
-    head?: HeadData;
-    /**
-     * Props passed to layout components (dynamic, per-request)
-     *
-     * These props are merged with static layout props from decorators:
-     * - Static props from @Layout decorator (controller level)
-     * - Static props from @Render decorator (method level)
-     * - Dynamic props from this field (highest priority)
-     *
-     * All layout components in the hierarchy receive the merged props.
-     */
-    layoutProps?: Record<string, any>;
-}
-
 /**
  * SSR rendering mode configuration
  */
@@ -533,4 +431,4 @@ declare function ErrorPageDevelopment({ error, viewPath, phase, }: ErrorPageDeve
  */
 declare function ErrorPageProduction(): react_jsx_runtime.JSX.Element;
 
-export { ErrorPageDevelopment as E, type HeadData as H, type RenderResponse as R, StreamingErrorHandler as S, TemplateParserService as T, RenderModule as a, RenderService as b, RenderInterceptor as c, type RenderConfig as d, type SSRMode as e, ErrorPageProduction as f };
+export { ErrorPageDevelopment as E, RenderModule as R, StreamingErrorHandler as S, TemplateParserService as T, RenderService as a, RenderInterceptor as b, type RenderConfig as c, type SSRMode as d, ErrorPageProduction as e };

package/dist/{index-C5Knql-9.d.ts → index-Dq1yt0sX.d.mts}

@@ -1,114 +1,12 @@
 import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
 import { ComponentType } from 'react';
+import { H as HeadData } from './render-response.interface-Dc-Kwb09.mjs';
 import { ViteDevServer } from 'vite';
 import { Response } from 'express';
 import { Reflector } from '@nestjs/core';
 import { Observable } from 'rxjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
-/**
- * HTML head data for SEO and page metadata
- */
-interface HeadData {
-    /** Page title (appears in browser tab and search results) */
-    title?: string;
-    /** Page description for search engines */
-    description?: string;
-    /** Page keywords (legacy, less important for modern SEO) */
-    keywords?: string;
-    /** Canonical URL for duplicate content */
-    canonical?: string;
-    /** Open Graph title for social media sharing */
-    ogTitle?: string;
-    /** Open Graph description for social media sharing */
-    ogDescription?: string;
-    /** Open Graph image URL for social media previews */
-    ogImage?: string;
-    /** Additional link tags (fonts, icons, preloads, etc.) */
-    links?: Array<{
-        rel: string;
-        href: string;
-        as?: string;
-        type?: string;
-        crossorigin?: string;
-        [key: string]: any;
-    }>;
-    /** Additional meta tags */
-    meta?: Array<{
-        name?: string;
-        property?: string;
-        content: string;
-        [key: string]: any;
-    }>;
-    /** Script tags for analytics, tracking, etc. */
-    scripts?: Array<{
-        src?: string;
-        async?: boolean;
-        defer?: boolean;
-        type?: string;
-        innerHTML?: string;
-        [key: string]: any;
-    }>;
-    /** JSON-LD structured data for search engines */
-    jsonLd?: Array<Record<string, any>>;
-    /** Attributes to add to <html> tag (e.g., lang, dir) */
-    htmlAttributes?: Record<string, string>;
-    /** Attributes to add to <body> tag (e.g., class, data-theme) */
-    bodyAttributes?: Record<string, string>;
-}
-/**
- * Response structure for SSR rendering
- *
- * Can be returned from controllers decorated with @Render.
- * For backwards compatibility, controllers can also return plain objects
- * which will be auto-wrapped as { props: data }.
- *
- * @example
- * ```typescript
- * // Simple case - just props (auto-wrapped)
- * @Render('views/home')
- * getHome() {
- *   return { message: 'Hello' };
- *   // Treated as: { props: { message: 'Hello' } }
- * }
- *
- * // Advanced case - with head data and layout props
- * @Render('views/user')
- * getUser(@Param('id') id: string) {
- *   const user = await this.userService.findOne(id);
- *   return {
- *     props: { user },
- *     layoutProps: {
- *       title: user.name,
- *       subtitle: 'User Profile'
- *     },
- *     head: {
- *       title: `${user.name} - Profile`,
- *       description: user.bio,
- *       ogImage: user.avatar
- *     }
- *   };
- * }
- * ```
- */
-interface RenderResponse<T = any> {
-    /** Props passed to the React component */
-    props: T;
-    /** HTML head data (title, meta tags, links) */
-    head?: HeadData;
-    /**
-     * Props passed to layout components (dynamic, per-request)
-     *
-     * These props are merged with static layout props from decorators:
-     * - Static props from @Layout decorator (controller level)
-     * - Static props from @Render decorator (method level)
-     * - Dynamic props from this field (highest priority)
-     *
-     * All layout components in the hierarchy receive the merged props.
-     */
-    layoutProps?: Record<string, any>;
-}
-
 /**
  * SSR rendering mode configuration
  */
@@ -533,4 +431,4 @@ declare function ErrorPageDevelopment({ error, viewPath, phase, }: ErrorPageDeve
  */
 declare function ErrorPageProduction(): react_jsx_runtime.JSX.Element;
 
-export { ErrorPageDevelopment as E, type HeadData as H, type RenderResponse as R, StreamingErrorHandler as S, TemplateParserService as T, RenderModule as a, RenderService as b, RenderInterceptor as c, type RenderConfig as d, type SSRMode as e, ErrorPageProduction as f };
+export { ErrorPageDevelopment as E, RenderModule as R, StreamingErrorHandler as S, TemplateParserService as T, RenderService as a, RenderInterceptor as b, type RenderConfig as c, type SSRMode as d, ErrorPageProduction as e };