@gesslar/bedoc 1.4.4 → 1.4.7

package/dist/types/core/ActionManager.d.ts

@@ -21,13 +21,16 @@ export type MetaType = ParseMetaDefinition | PrintMetaDefinition
 
 export interface ActionDefinition {
   meta: MetaType
+  setup?: (params: { parent: ActionManager; log: Logger }) => void
+  run({ module, content }: { module: string; content: object }): Promise<string>
+  hook?: (event: string, ...args: unknown[]) => Promise<unknown>
 }
 
-export interface PrintActionDefinition {
+export interface PrintActionDefinition extends ActionDefinition {
   meta: PrintMetaDefinition
 }
 
-export interface ParseActionDefinition {
+export interface ParseActionDefinition extends ActionDefinition {
   meta: ParseMetaDefinition
 }
 
@@ -48,4 +51,6 @@ export default class ActionManager {
   toString(): string
   #private
 }
+
+export type ActionContract = string
 //# sourceMappingURL=ActionManager.d.ts.map

package/dist/types/core/HookManager.d.ts

@@ -1,7 +1,7 @@
 import Logger from './Logger';
 import { FileMap } from './util/FDUtil';
 
-type HookEvent = 'start' | 'section_load' | 'enter' | 'exit' | 'end';
+export type HookEventType = 'start' | 'section_load' | 'enter' | 'exit' | 'end';
 
 interface HookResult {
     status?: 'success' | 'error';
@@ -27,7 +27,7 @@ interface HookManagerConstructorParams {
     timeOut: number;
 }
 
-export const hookPoints: Readonly<Record<Uppercase<HookEvent>, HookEvent>>;
+export const hookPoints: Readonly<Record<Uppercase<HookEventType>, HookEventType>>;
 
 export default class HookManager {
     static new(arg: HookManagerConstructorParams): Promise<HookManager | null>;
@@ -35,7 +35,7 @@ export default class HookManager {
     constructor({ action, hooksFile, logger, timeOut: timeout }: HookManagerConstructorParams);
 
     get action(): string;
-    get hooksFile(): FileMap;
+    get hooksFile(): FileMap | null;
     get hooks(): HooksDefinition | null;
     get log(): Logger;
     get timeout(): number;
@@ -49,8 +49,9 @@ export default class HookManager {
      * @param args - The hook arguments
      * @returns The result of the hook
      */
-    on(event: HookEvent, ...args: unknown[]): Promise<HookResult | undefined>;
+    on(event: HookEventType, ...args: unknown[]): Promise<HookResult | undefined>;
 
+    HOOKS?: HookPoints
     #hooksFile: FileMap | null;
     #log: Logger | null;
     #hooks: HooksDefinition | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/bedoc",
-  "version": "1.4.4",
+  "version": "1.4.7",
   "description": "Pluggable documentation engine for any language and format",
   "publisher": "gesslar",
   "main": "./src/core/Core.js",

package/src/core/ActionManager.js

@@ -1,4 +1,4 @@
-import {hookPoints} from "./HookManager.js"
+import {HookPoints} from "./HookManager.js"
 
 export default class ActionManager {
   #action = null
@@ -48,7 +48,7 @@ export default class ActionManager {
       throw new Error("Hooks already set")
 
     this.action.hook = hookManager.on.bind(this.action)
-    this.action.HOOKS = hookPoints
+    this.action.HOOKS = HookPoints
     this.#hookManager = hookManager
     this.action.hooks = hookManager.hooks
   }

package/src/core/HookManager.js

@@ -8,7 +8,7 @@ const {assert} = ValidUtil
 const freeze = Object.freeze
 
 const hookEvents = freeze(["start", "section_load", "enter", "exit", "end"])
-export const hookPoints = freeze(
+export const HookPoints = freeze(
   await allocateObject(
     hookEvents.map((event) => event.toUpperCase()),
     hookEvents,