npm - @nestjs-ssr/react - Versions diffs - 0.1.1 - Mend

@nestjs-ssr/react 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/LICENSE +22 -0
package/README.md +587 -0
package/dist/index-Bptct1Q3.d.mts +419 -0
package/dist/index-Bptct1Q3.d.ts +419 -0
package/dist/index.d.mts +220 -0
package/dist/index.d.ts +220 -0
package/dist/index.js +8148 -0
package/dist/index.js.map +1 -0
package/dist/index.mjs +8113 -0
package/dist/index.mjs.map +1 -0
package/dist/render/index.d.mts +8 -0
package/dist/render/index.d.ts +8 -0
package/dist/render/index.js +1110 -0
package/dist/render/index.js.map +1 -0
package/dist/render/index.mjs +1102 -0
package/dist/render/index.mjs.map +1 -0
package/dist/templates/entry-client.tsx +20 -0
package/dist/templates/entry-server.tsx +13 -0
package/dist/templates/index.html +17 -0
package/dist/vite/index.d.mts +11 -0
package/dist/vite/index.d.ts +11 -0
package/dist/vite/index.js +7022 -0
package/dist/vite/index.js.map +1 -0
package/dist/vite/index.mjs +6997 -0
package/dist/vite/index.mjs.map +1 -0
package/package.json +135 -0
package/src/global.d.ts +32 -0
package/src/templates/entry-client.tsx +20 -0
package/src/templates/entry-server.tsx +13 -0
package/src/templates/index.html +17 -0

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,220 @@
+import { H as HeadData } from './index-Bptct1Q3.js';
+export { E as ErrorPageDevelopment, f as ErrorPageProduction, c as RenderConfig, b as RenderInterceptor, R as RenderModule, e as RenderResponse, a as RenderService, d as SSRMode, S as StreamingErrorHandler, T as TemplateParserService } from './index-Bptct1Q3.js';
+import * as _nestjs_common from '@nestjs/common';
+export { viewRegistryPlugin } from './vite/index.js';
+import 'react';
+import 'vite';
+import 'express';
+import '@nestjs/core';
+import 'rxjs';
+import 'react/jsx-runtime';
+/**
+ * Request context available to all React components.
+ * Contains safe request metadata that can be exposed to the client.
+ *
+ * @example
+ * // Basic usage - use as-is
+ * const context: RenderContext = {
+ *   url: '/users/123',
+ *   path: '/users/123',
+ *   query: { tab: 'profile' },
+ *   params: { id: '123' },
+ * };
+ *
+ * @example
+ * // Extended usage - add custom properties for your app
+ * interface AppRenderContext extends RenderContext {
+ *   user?: {
+ *     id: string;
+ *     name: string;
+ *     email: string;
+ *     roles: string[];
+ *   };
+ *   tenant?: {
+ *     id: string;
+ *     name: string;
+ *   };
+ *   locale?: string;
+ * }
+ *
+ * // Use in interceptor
+ * const context: AppRenderContext = {
+ *   ...baseContext,
+ *   user: req.user,
+ *   tenant: req.tenant,
+ *   locale: req.locale,
+ * };
+ */
+interface RenderContext {
+    url: string;
+    path: string;
+    query: Record<string, string | string[]>;
+    params: Record<string, string>;
+    userAgent?: string;
+    acceptLanguage?: string;
+    referer?: string;
+    [key: string]: any;
+}
+/**
+ * Generic type for React page component props.
+ * Spreads controller data directly as props (React-standard pattern).
+ *
+ * @template TProps - The shape of props returned by the controller
+ *
+ * @example
+ * ```typescript
+ * interface ProductPageProps {
+ *   product: Product;
+ *   relatedProducts: Product[];
+ * }
+ *
+ * export default function ProductDetail(props: PageProps<ProductPageProps>) {
+ *   const { product, relatedProducts, head, context } = props;
+ *   return (
+ *     <html>
+ *       <head>
+ *         <title>{head?.title || product.name}</title>
+ *       </head>
+ *       <body>
+ *         <h1>{product.name}</h1>
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ */
+type PageProps<TProps = {}> = TProps & {
+    /**
+     * Optional head metadata for SEO (title, description, og tags, etc.)
+     * Pass from controller to populate meta tags, Open Graph, etc.
+     *
+     * @example
+     * ```typescript
+     * // In controller:
+     * return {
+     *   product,
+     *   head: {
+     *     title: product.name,
+     *     description: product.description,
+     *   }
+     * };
+     *
+     * // In component:
+     * <head>
+     *   <title>{props.head?.title}</title>
+     *   <meta name="description" content={props.head?.description} />
+     * </head>
+     * ```
+     */
+    head?: HeadData;
+    /**
+     * Request context containing URL metadata and safe headers.
+     * Always available on every page component.
+     *
+     * @example
+     * ```typescript
+     * const { path, query, method } = props.context;
+     * ```
+     */
+    context: RenderContext;
+};
+/**
+ * Interface for view paths - augmented by the generated view registry.
+ * This enables type-safe path validation in Render decorator.
+ */
+interface ViewPaths {
+}
+/**
+ * Type-safe view path - union of all registered view paths.
+ * This is populated via module augmentation from the generated view registry.
+ */
+type ViewPath = keyof ViewPaths extends never ? string : keyof ViewPaths;
+/**
+ * Decorator to render a React component as the response.
+ * Provides IDE autocomplete and type checking for view paths.
+ *
+ * Works the same as NestJS's @Render() decorator for template engines,
+ * but renders React components with SSR instead.
+ *
+ * @param viewPath - Path to the React component (e.g., 'users/views/user-list')
+ *
+ * @example
+ * ```typescript
+ * @Get()
+ * @Render('users/views/user-list')
+ * getUsers() {
+ *   return { users: [...] };
+ * }
+ * ```
+ */
+declare const Render: (viewPath: ViewPath) => _nestjs_common.CustomDecorator<string>;
+/**
+ * @deprecated Use `Render` instead. This alias will be removed in a future version.
+ */
+declare const ReactRender: (viewPath: ViewPath) => _nestjs_common.CustomDecorator<string>;
+/**
+ * Hook to access the full page context.
+ * Contains URL metadata and request headers.
+ *
+ * For apps with authentication, extend RenderContext and create custom hooks.
+ *
+ * @throws Error if used outside PageContextProvider
+ *
+ * @example
+ * ```tsx
+ * const context = usePageContext();
+ * console.log(context.path);  // '/users/123'
+ * console.log(context.query); // { search: 'foo' }
+ * ```
+ *
+ * @example
+ * // Custom hook for extended context
+ * interface AppRenderContext extends RenderContext {
+ *   user?: { id: string; name: string };
+ * }
+ *
+ * export function useUser() {
+ *   return (usePageContext() as AppRenderContext).user;
+ * }
+ */
+declare function usePageContext(): RenderContext;
+/**
+ * Hook to access route parameters.
+ *
+ * @example
+ * ```tsx
+ * // Route: /users/:id
+ * const params = useParams();
+ * console.log(params.id); // '123'
+ * ```
+ */
+declare function useParams(): Record<string, string>;
+/**
+ * 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'
+ * ```
+ */
+declare function useQuery(): Record<string, string | string[]>;
+/**
+ * Hook to access the User-Agent header.
+ * Useful for device detection or analytics.
+ *
+ * @example
+ * ```tsx
+ * const userAgent = useUserAgent();
+ * const isMobile = /Mobile/.test(userAgent || '');
+ * ```
+ */
+declare function useUserAgent(): string | undefined;
+export { HeadData, type PageProps, ReactRender, Render, type RenderContext, type ViewPath, type ViewPaths, usePageContext, useParams, useQuery, useUserAgent };