Docs/framework api typedoc markdown

.changeset/orange-cobras-drum.md

@@ -0,0 +1,5 @@
+---
+'@o2s/framework': minor
+---
+
+feat(framework): expose richer API surface and add framework API reference docs

apps/docs/.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+/docs/api
 
 # Misc
 .DS_Store

apps/docs/docs/guides/framework-api-reference.md

@@ -0,0 +1,17 @@
+---
+sidebar_position: 210
+---
+
+# @o2s/framework API Reference
+
+The `@o2s/framework` package provides types, modules, models, and SDK for building API Harmonization servers and frontend integrations.
+
+## Full reference (TypeDoc)
+
+The detailed reference (all types, classes, methods) is generated automatically from the source at docs build time ([TypeDoc](https://typedoc.org/) + [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown)).
+
+**[Open full @o2s/framework API reference →](/docs/api)**
+
+## How it is updated
+
+API documentation is generated when you run `npm run build` or `npm run start` in the docs app from `packages/framework`. No manual update is required.

apps/docs/docs/guides/overview.md

@@ -16,6 +16,7 @@ This section provides practical instructions and best practices for working with
 - **[Code style](./code-style.md)** – Ensure consistency across the codebase with established coding conventions.
 - **[Adding new components with generators](./using-generators.md)** – Learn how to extend and customize O2S by quickly bootstrapping its components.
 - **[The SDK](./sdk.md)** – Understand how to interact with the API Harmonization Server using the built-in TypeScript SDK.
+- **[@o2s/framework API Reference](./framework-api-reference.md)** – Auto-generated type and module documentation for the core framework.
 
 ### Integrations
 

apps/docs/docusaurus.config.ts

@@ -7,7 +7,7 @@ import tailwindPlugin from './plugins/tailwind-config';
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
-let hideDocs = false;
+const hideDocs = false;
 
 const config: Config = {
     title: 'Open Self Service',
@@ -257,6 +257,17 @@ const config: Config = {
         },
     },
     plugins: [
+        [
+            'docusaurus-plugin-typedoc',
+            {
+                entryPoints: ['../../packages/framework/src/index.ts', '../../packages/framework/src/sdk.ts'],
+                tsconfig: '../../packages/framework/tsconfig.json',
+                out: 'docs/api',
+                name: '@o2s/framework API',
+                excludePrivate: true,
+                readme: 'none',
+            },
+        ],
         tailwindPlugin,
         '@docusaurus/theme-mermaid',
         'docusaurus-plugin-image-zoom',

apps/docs/package.json

@@ -39,6 +39,9 @@
     },
     "devDependencies": {
         "@docusaurus/module-type-aliases": "3.9.2",
+        "docusaurus-plugin-typedoc": "^1.4.0",
+        "typedoc": "^0.28.17",
+        "typedoc-plugin-markdown": "^4.10.0",
         "@docusaurus/tsconfig": "3.9.2",
         "@docusaurus/types": "3.9.2",
         "@o2s/eslint-config": "*",
@@ -68,4 +71,4 @@
     "engines": {
         "node": ">=18.0"
     }
-}
+}

packages/framework/package.json

@@ -73,4 +73,4 @@
         "@nestjs/core": "^11",
         "rxjs": "^7"
     }
-}
+}

packages/framework/src/index.ts

@@ -2,21 +2,39 @@ export type { ApiConfig } from './api-config';
 
 export * as Models from './utils/models';
 
+/** Headless CMS: pages, entries, blocks, header/footer, app config. */
 export * as CMS from './modules/cms';
+/** Support tickets: list, single, create. */
 export * as Tickets from './modules/tickets';
+/** User notifications: list, single, mark as read. */
 export * as Notifications from './modules/notifications';
+/** Articles and categories (knowledge base, blog). */
 export * as Articles from './modules/articles';
+/** Invoices: list, single, PDF. */
 export * as Invoices from './modules/invoices';
+/** Resources, services, assets: list, purchase, compatible/featured. */
 export * as Resources from './modules/resources';
+/** Users and current-user: get, update, delete, customers. */
 export * as Users from './modules/users';
+/** Organizations: list, single, membership check. */
 export * as Organizations from './modules/organizations';
+/** Authentication (no controller): service for login/session. */
 export * as Auth from './modules/auth';
+/** Cache (no controller): service for get/set/delete. */
 export * as Cache from './modules/cache';
+/** Billing accounts: list, single. */
 export * as BillingAccounts from './modules/billing-accounts';
+/** Search: payload/result types; optional service/controller. */
 export * as Search from './modules/search';
+/** Products: list, single, related. */
 export * as Products from './modules/products';
+/** Orders: list, single. */
 export * as Orders from './modules/orders';
+/** Carts: CRUD, items, promotions, prepare checkout. */
 export * as Carts from './modules/carts';
+/** Customer addresses: list, CRUD, set default. */
 export * as Customers from './modules/customers';
+/** Payments: providers, sessions (create/update/cancel). */
 export * as Payments from './modules/payments';
+/** Checkout: addresses, shipping, payment, place order. */
 export * as Checkout from './modules/checkout';

packages/framework/src/modules/articles/articles.controller.ts

@@ -5,6 +5,10 @@ import { LoggerService } from '@o2s/utils.logger';
 
 import { ArticlesService } from './articles.service';
 
+/**
+ * HTTP controller for articles and categories. Base path: `/articles`.
+ * All methods delegate to {@link ArticlesService}.
+ */
 @Controller('/articles')
 @UseInterceptors(LoggerService)
 export class ArticleController {