Merge branch 'main' into docs/framework-api-typedoc-markdown

Author: tomaszpacior

.changeset/social-mammals-beam.md

@@ -0,0 +1,13 @@
+---
+'@o2s/configs.integrations': minor
+'@o2s/api-harmonization': minor
+'@o2s/framework': minor
+'@o2s/docs': minor
+'@o2s/integrations.mocked': minor
+---
+
+add createModule() factory for custom framework modules
+
+Enable developers to define new base modules beyond the core modules using createModule(). Custom modules are registered directly in app.module.ts, following the same pattern as SurveyJS.
+
+Includes example documents module in mocked integration, custom-module Turbo generator, and documentation guide.

apps/api-harmonization/src/app.module.ts

@@ -2,7 +2,7 @@ import { HttpModule } from '@nestjs/axios';
 import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
 import { APP_GUARD, Reflector } from '@nestjs/core';
-import { Auth } from '@o2s/configs.integrations';
+import { Auth, Documents } from '@o2s/configs.integrations';
 import * as SurveyJs from '@o2s/modules.surveyjs/api-harmonization';
 
 import { LoggerModule, LoggerService } from '@o2s/utils.logger';
@@ -26,6 +26,7 @@ import {
     Search,
     Tickets,
     Users,
+    createModule,
 } from '@o2s/framework/modules';
 
 import * as ArticleList from '@o2s/blocks.article-list/api-harmonization';
@@ -102,6 +103,14 @@ export const PaymentsBaseModule = Payments.Module.register(AppConfig);
 export const CheckoutBaseModule = Checkout.Module.register(AppConfig);
 export const AuthModuleBaseModule = AuthModule.Module.register(AppConfig);
 
+const DocumentsModule = createModule('documents');
+export const DocumentsBaseModule = DocumentsModule.register({
+    name: 'documents',
+    service: Documents.Service,
+    serviceImpl: Documents.MockedService,
+    controller: Documents.Controller,
+});
+
 @Module({
     imports: [
         HttpModule.register({ global: true }),
@@ -133,6 +142,8 @@ export const AuthModuleBaseModule = AuthModule.Module.register(AppConfig);
         CheckoutBaseModule,
         AuthModuleBaseModule,
 
+        DocumentsBaseModule,
+
         PageModule.register(AppConfig),
         RoutesModule.register(AppConfig),
         LoginPageModule.register(AppConfig),

apps/docs/docs/guides/integrations/adding-new-integrations.md

@@ -154,3 +154,9 @@ You can achieve that by following a few steps:
 :::tip
 For a full example about injecting dependencies, you can check the source code od the [Strapi CMS integration](../../integrations/cms/strapi/overview.md).
 :::
+
+## Implementing custom modules
+
+If your project uses [custom modules](./extending-framework-modules.md) (modules beyond the core framework modules), you can add implementations for them to your integration. The process is the same as for core modules — create a service extending the custom module's abstract service and wire it into the integration's `CustomModules` export.
+
+For a complete walkthrough, see [Extending framework modules](./extending-framework-modules.md).