@nestjs-ssr/react 0.2.3 → 0.2.5

package/dist/render/index.mjs

@@ -1129,39 +1129,32 @@ var RenderModule = class _RenderModule {
     __name(this, "RenderModule");
   }
   /**
-  * Register the render module with optional configuration
+  * Configure the render module
   *
   * @param config - Optional render configuration
   * @returns Dynamic module
   *
   * @example
   * ```ts
-  * // Zero config - embedded mode by default (simplest)
-  * @Module({
-  *   imports: [RenderModule],
-  * })
+  * // Zero config - uses defaults
+  * RenderModule.forRoot()
+  *
+  * // Enable streaming SSR
+  * RenderModule.forRoot({ mode: 'stream' })
   *
   * // Enable HMR with proxy mode
-  * @Module({
-  *   imports: [
-  *     RenderModule.register({
-  *       vite: { mode: 'proxy', port: 5173 }
-  *     })
-  *   ],
+  * RenderModule.forRoot({
+  *   vite: { mode: 'proxy', port: 5173 }
   * })
   *
-  * // Enable streaming SSR
-  * RenderModule.register({ mode: 'stream' })
-  *
   * // Custom error pages
-  * RenderModule.register({
-  *   mode: 'stream',
-  *   errorPageDevelopment: MyCustomDevErrorPage,
-  *   errorPageProduction: MyCustomProdErrorPage,
+  * RenderModule.forRoot({
+  *   errorPageDevelopment: DevErrorPage,
+  *   errorPageProduction: ProdErrorPage,
   * })
   * ```
   */
-  static register(config) {
+  static forRoot(config) {
     const providers = [
       RenderService,
       TemplateParserService,
@@ -1224,35 +1217,42 @@ var RenderModule = class _RenderModule {
     };
   }
   /**
-  * Register the render module asynchronously with dynamic configuration
+  * Configure the render module with async factory
   *
-  * Use this when you need to inject services (e.g., load config from database)
+  * Use when configuration depends on other services (database, config service, etc.)
   *
   * @param options - Async configuration options
   * @returns Dynamic module
   *
   * @example
   * ```ts
-  * // Load default head from database
-  * RenderModule.registerAsync({
+  * // Load config from ConfigService
+  * RenderModule.forRootAsync({
+  *   imports: [ConfigModule],
+  *   inject: [ConfigService],
+  *   useFactory: (config: ConfigService) => ({
+  *     mode: config.get('SSR_MODE'),
+  *     defaultHead: { title: config.get('APP_NAME') },
+  *   }),
+  * })
+  *
+  * // Load from database
+  * RenderModule.forRootAsync({
   *   imports: [TenantModule],
-  *   inject: [TenantRepository],
-  *   useFactory: async (tenantRepo: TenantRepository) => {
-  *     const tenant = await tenantRepo.findDefaultTenant();
+  *   inject: [TenantService],
+  *   useFactory: async (tenantService: TenantService) => {
+  *     const tenant = await tenantService.getCurrent();
   *     return {
   *       defaultHead: {
-  *         title: tenant.appName,
-  *         description: tenant.description,
-  *         links: [
-  *           { rel: 'icon', href: tenant.favicon }
-  *         ]
-  *       }
+  *         title: tenant.name,
+  *         links: [{ rel: 'icon', href: tenant.favicon }],
+  *       },
   *     };
-  *   }
+  *   },
   * })
   * ```
   */
-  static registerAsync(options) {
+  static forRootAsync(options) {
     const configProvider = {
       provide: "RENDER_CONFIG",
       useFactory: options.useFactory,
@@ -1268,7 +1268,6 @@ var RenderModule = class _RenderModule {
         provide: APP_INTERCEPTOR,
         useClass: RenderInterceptor
       },
-      // Vite configuration provider - reads from config
       {
         provide: "VITE_CONFIG",
         useFactory: /* @__PURE__ */ __name((config) => config?.vite || {}, "useFactory"),
@@ -1276,7 +1275,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // SSR mode provider - reads from config
       {
         provide: "SSR_MODE",
         useFactory: /* @__PURE__ */ __name((config) => config?.mode, "useFactory"),
@@ -1284,7 +1282,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // Error page providers - read from config
       {
         provide: "ERROR_PAGE_DEVELOPMENT",
         useFactory: /* @__PURE__ */ __name((config) => config?.errorPageDevelopment, "useFactory"),
@@ -1299,7 +1296,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // Default head provider - reads from config
       {
         provide: "DEFAULT_HEAD",
         useFactory: /* @__PURE__ */ __name((config) => config?.defaultHead, "useFactory"),
@@ -1307,7 +1303,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // Custom template provider - reads from config
       {
         provide: "CUSTOM_TEMPLATE",
         useFactory: /* @__PURE__ */ __name((config) => config?.template, "useFactory"),
@@ -1315,7 +1310,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // Allowed headers provider - reads from config
       {
         provide: "ALLOWED_HEADERS",
         useFactory: /* @__PURE__ */ __name((config) => config?.allowedHeaders || [], "useFactory"),
@@ -1323,7 +1317,6 @@ var RenderModule = class _RenderModule {
           "RENDER_CONFIG"
         ]
       },
-      // Allowed cookies provider - reads from config
       {
         provide: "ALLOWED_COOKIES",
         useFactory: /* @__PURE__ */ __name((config) => config?.allowedCookies || [], "useFactory"),
@@ -1342,6 +1335,18 @@ var RenderModule = class _RenderModule {
       ]
     };
   }
+  /**
+  * @deprecated Use forRoot() instead
+  */
+  static register(config) {
+    return this.forRoot(config);
+  }
+  /**
+  * @deprecated Use forRootAsync() instead
+  */
+  static registerAsync(options) {
+    return this.forRootAsync(options);
+  }
 };
 RenderModule = _ts_decorate6([
   Global(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-ssr/react",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "React SSR for NestJS that respects Clean Architecture. Proper DI, SOLID principles, clear separation of concerns.",
   "keywords": [
     "nestjs",