@nodefony/documentation 10.0.0-alpha.2 → 10.0.0-alpha.4
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.
- package/dist/_virtual/{_@oxc-project_runtime@0.148.0 → _@oxc-project_runtime@0.149.0}/helpers/esm/decorate.js +1 -1
- package/dist/_virtual/{_@oxc-project_runtime@0.148.0 → _@oxc-project_runtime@0.149.0}/helpers/esm/decorateMetadata.js +1 -1
- package/dist/_virtual/{_@oxc-project_runtime@0.148.0 → _@oxc-project_runtime@0.149.0}/helpers/esm/decorateParam.js +1 -1
- package/dist/index.js +2 -2
- package/dist/nodefony/controller/DocumentationController.js +3 -3
- package/dist/types/index.d.ts +4 -4
- package/dist/types/nodefony/config/config.d.ts +3 -3
- package/dist/types/nodefony/config/defineModuleConfig.d.ts +2 -2
- package/dist/types/nodefony/service/DocumentationService.d.ts +0 -2
- package/package.json +7 -7
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//#region \0@oxc-project+runtime@0.
|
|
1
|
+
//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
|
|
2
2
|
function __decorate(decorators, target, key, desc) {
|
|
3
3
|
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
4
|
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//#region \0@oxc-project+runtime@0.
|
|
1
|
+
//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateMetadata.js
|
|
2
2
|
function __decorateMetadata(k, v) {
|
|
3
3
|
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
4
4
|
}
|
package/dist/index.js
CHANGED
|
@@ -7,8 +7,8 @@ import { rewriteInternalLinks } from "./nodefony/src/linkResolver.js";
|
|
|
7
7
|
import { extractSearchText, foldText, searchDocs, splitSearchTerms } from "./nodefony/src/search.js";
|
|
8
8
|
import { DocNotFoundError, DocUnsafeSlugError, DocumentationError } from "./nodefony/src/errors/DocumentationError.js";
|
|
9
9
|
import DocumentationService, { ROOT_GROUPS, ROOT_PAGES } from "./nodefony/service/DocumentationService.js";
|
|
10
|
-
import __decorateMetadata from "./_virtual/_@oxc-project_runtime@0.
|
|
11
|
-
import __decorate from "./_virtual/_@oxc-project_runtime@0.
|
|
10
|
+
import __decorateMetadata from "./_virtual/_@oxc-project_runtime@0.149.0/helpers/esm/decorateMetadata.js";
|
|
11
|
+
import __decorate from "./_virtual/_@oxc-project_runtime@0.149.0/helpers/esm/decorate.js";
|
|
12
12
|
import DocumentationController_default from "./nodefony/controller/DocumentationController.js";
|
|
13
13
|
import { GitService, Kernel, Module, services } from "nodefony";
|
|
14
14
|
import { controllers } from "@nodefony/framework";
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { DocNotFoundError, DocUnsafeSlugError } from "../src/errors/DocumentationError.js";
|
|
2
|
-
import __decorateMetadata from "../../_virtual/_@oxc-project_runtime@0.
|
|
3
|
-
import __decorate from "../../_virtual/_@oxc-project_runtime@0.
|
|
4
|
-
import __decorateParam from "../../_virtual/_@oxc-project_runtime@0.
|
|
2
|
+
import __decorateMetadata from "../../_virtual/_@oxc-project_runtime@0.149.0/helpers/esm/decorateMetadata.js";
|
|
3
|
+
import __decorate from "../../_virtual/_@oxc-project_runtime@0.149.0/helpers/esm/decorate.js";
|
|
4
|
+
import __decorateParam from "../../_virtual/_@oxc-project_runtime@0.149.0/helpers/esm/decorateParam.js";
|
|
5
5
|
import { Controller, Get, IsGranted, Param, Query, controller } from "@nodefony/framework";
|
|
6
6
|
import { Context } from "@nodefony/http";
|
|
7
7
|
//#region nodefony/controller/DocumentationController.ts
|
package/dist/types/index.d.ts
CHANGED
|
@@ -16,15 +16,15 @@
|
|
|
16
16
|
* README.md (usage humain), docs/ (doc vulgarisée surfacée dans Studio).
|
|
17
17
|
*/
|
|
18
18
|
import { Kernel, Module } from "nodefony";
|
|
19
|
-
import type {
|
|
19
|
+
import type { IDocumentationConfig, IDocumentationConfigInput } from "./nodefony/config/config.js";
|
|
20
20
|
import DocumentationService from "./nodefony/service/DocumentationService.js";
|
|
21
21
|
import DocumentationController from "./nodefony/controller/DocumentationController.js";
|
|
22
22
|
declare module "nodefony" {
|
|
23
23
|
interface NodefonyModuleConfig {
|
|
24
|
-
"@nodefony/documentation":
|
|
24
|
+
"@nodefony/documentation": IDocumentationConfigInput;
|
|
25
25
|
}
|
|
26
26
|
}
|
|
27
|
-
declare class Documentation extends Module<
|
|
27
|
+
declare class Documentation extends Module<IDocumentationConfig> {
|
|
28
28
|
/** Module optionnel : un échec de son boot ne tue jamais le process (résilience Ph.3). */
|
|
29
29
|
static critical: boolean;
|
|
30
30
|
constructor(kernel: Kernel);
|
|
@@ -48,7 +48,7 @@ export default Documentation;
|
|
|
48
48
|
export { DocumentationService, DocumentationController };
|
|
49
49
|
export { ROOT_GROUPS, ROOT_PAGES, } from "./nodefony/service/DocumentationService.js";
|
|
50
50
|
export { defineDocumentationConfig, documentationConfigJsonSchema, } from "./nodefony/config/defineModuleConfig.js";
|
|
51
|
-
export { documentationConfigSchema, type
|
|
51
|
+
export { documentationConfigSchema, type IDocumentationConfig, type IDocumentationConfigInput, } from "./nodefony/config/config.js";
|
|
52
52
|
export { parseFrontmatter, metaString, metaList, type Frontmatter, type ParsedDoc, } from "./nodefony/src/frontmatter.js";
|
|
53
53
|
export { scanDocsDir, type ScannedDoc } from "./nodefony/src/docScanner.js";
|
|
54
54
|
export { isSafeSlug, pathToSlug, type DocSource } from "./nodefony/src/slug.js";
|
|
@@ -21,17 +21,17 @@ export declare const documentationConfigSchema: z.ZodObject<{
|
|
|
21
21
|
}, z.core.$strict>>;
|
|
22
22
|
}, z.core.$strict>;
|
|
23
23
|
/** Type de sortie (config normalisée + défauts appliqués). */
|
|
24
|
-
export type
|
|
24
|
+
export type IDocumentationConfig = z.infer<typeof documentationConfigSchema>;
|
|
25
25
|
/**
|
|
26
26
|
* Type d'ENTRÉE (ce que l'utilisateur écrit dans `use()`, avant application des
|
|
27
27
|
* défauts) — tout y est optionnel. C'est CE type qui augmente le registre
|
|
28
28
|
* `NodefonyModuleConfig`, jamais la sortie : exiger la forme normalisée
|
|
29
29
|
* obligerait l'app à réécrire chaque défaut.
|
|
30
30
|
*/
|
|
31
|
-
export type
|
|
31
|
+
export type IDocumentationConfigInput = z.input<typeof documentationConfigSchema>;
|
|
32
32
|
/**
|
|
33
33
|
* Défauts du module, matérialisés depuis le schéma (source unique). Toujours
|
|
34
34
|
* valides par construction ; passés au `super(..., config)` du Module class.
|
|
35
35
|
*/
|
|
36
|
-
declare const config:
|
|
36
|
+
declare const config: IDocumentationConfig;
|
|
37
37
|
export default config;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type IDocumentationConfig } from "./config.js";
|
|
2
2
|
/**
|
|
3
3
|
* Valide une config partielle (défauts du schéma) PUIS applique la surcharge par
|
|
4
4
|
* variables d'environnement (précédence max).
|
|
@@ -7,7 +7,7 @@ import { type DocumentationConfig } from "./config.js";
|
|
|
7
7
|
* @returns config validée, défauts appliqués, env mergé
|
|
8
8
|
* @throws ZodError si l'input viole le schéma
|
|
9
9
|
*/
|
|
10
|
-
export declare function defineDocumentationConfig(input?: unknown):
|
|
10
|
+
export declare function defineDocumentationConfig(input?: unknown): IDocumentationConfig;
|
|
11
11
|
/**
|
|
12
12
|
* JSON Schema introspectable de la config documentation — destiné au panneau de
|
|
13
13
|
* config Studio (`/nodefony/config`). N'inclut PAS la surcharge ENV (appliquée
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { Module, Service, type Message, type Msgid, type Pci, type Severity } from "nodefony";
|
|
2
|
-
import type { DocumentationConfig } from "../config/config.js";
|
|
3
2
|
import type { DocVarProvider, IDocPage, IDocSearchResult, IDocTree } from "../interfaces/IDocumentation.js";
|
|
4
3
|
/**
|
|
5
4
|
* Les groupes racine publiés, **dans l'ordre du menu**, avec leur libellé.
|
|
@@ -75,4 +74,3 @@ declare class DocumentationService extends Service {
|
|
|
75
74
|
getPage(slug: string): Promise<IDocPage>;
|
|
76
75
|
}
|
|
77
76
|
export default DocumentationService;
|
|
78
|
-
export type { DocumentationConfig };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nodefony/documentation",
|
|
3
|
-
"version": "10.0.0-alpha.
|
|
3
|
+
"version": "10.0.0-alpha.4",
|
|
4
4
|
"description": "Plan de données de documentation de Nodefony : index des pages co-localisées dans chaque module, résolution des variables dynamiques, exposition en lecture pour la console d'administration",
|
|
5
5
|
"contributors": [],
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -36,18 +36,18 @@
|
|
|
36
36
|
"esm"
|
|
37
37
|
],
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@nodefony/framework": "^10.0.0-alpha.
|
|
40
|
-
"@nodefony/http": "^10.0.0-alpha.
|
|
39
|
+
"@nodefony/framework": "^10.0.0-alpha.4",
|
|
40
|
+
"@nodefony/http": "^10.0.0-alpha.4",
|
|
41
41
|
"@types/node": "26.4.1",
|
|
42
42
|
"@vitest/coverage-v8": "5.0.0",
|
|
43
|
-
"nodefony": "^10.0.0-alpha.
|
|
43
|
+
"nodefony": "^10.0.0-alpha.4",
|
|
44
44
|
"rimraf": "6.1.3",
|
|
45
45
|
"vitest": "5.0.0"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
|
-
"@nodefony/framework": "^10.0.0-alpha.
|
|
49
|
-
"@nodefony/http": "^10.0.0-alpha.
|
|
50
|
-
"nodefony": "^10.0.0-alpha.
|
|
48
|
+
"@nodefony/framework": "^10.0.0-alpha.4",
|
|
49
|
+
"@nodefony/http": "^10.0.0-alpha.4",
|
|
50
|
+
"nodefony": "^10.0.0-alpha.4",
|
|
51
51
|
"zod": "^4.4.3"
|
|
52
52
|
},
|
|
53
53
|
"repository": {
|