@gesslar/bedoc 1.4.3 → 1.4.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.
@@ -1,27 +1,51 @@
1
- import Logger from './Logger';
2
- import HookManager from './HookManager';
1
+ import Logger from './Logger'
2
+ import HookManager from './HookManager'
3
+
4
+ export type MetaActionType = "print" | "parse"
5
+
6
+ export interface MetaDefinition {
7
+ action: MetaActionType
8
+ }
9
+
10
+ export interface ParseMetaDefinition extends MetaDefinition {
11
+ action: "parse"
12
+ language: string
13
+ }
14
+
15
+ export interface PrintMetaDefinition extends MetaDefinition {
16
+ action: "print"
17
+ format: string
18
+ }
19
+
20
+ export type MetaType = ParseMetaDefinition | PrintMetaDefinition
3
21
 
4
22
  export interface ActionDefinition {
5
- action: string;
6
- contract: Record<string, unknown>;
7
- meta: Record<string, unknown>;
23
+ meta: MetaType
24
+ }
25
+
26
+ export interface PrintActionDefinition {
27
+ meta: PrintMetaDefinition
28
+ }
29
+
30
+ export interface ParseActionDefinition {
31
+ meta: ParseMetaDefinition
8
32
  }
9
33
 
10
34
  export default class ActionManager {
11
- constructor(actionDefinition: ActionDefinition, logger: Logger);
12
- get action(): ActionDefinition;
13
- set hookManager(hookManager: HookManager);
14
- get hookManager(): HookManager;
15
- get contract(): Record<string, unknown>;
16
- get meta(): Record<string, unknown>;
17
- get log(): Logger;
18
- setupAction(): Promise<void>;
35
+ constructor(actionDefinition: ActionDefinition, logger: Logger)
36
+ get action(): ActionDefinition
37
+ set hookManager(hookManager: HookManager)
38
+ get hookManager(): HookManager
39
+ get contract(): string
40
+ get meta(): MetaType
41
+ get log(): Logger
42
+ setupAction(): Promise<void>
19
43
  runAction({ file, content }: {
20
- file: string;
21
- content: string;
22
- }): Promise<string>;
23
- cleanupAction(): Promise<void>;
24
- toString(): string;
25
- #private;
44
+ file: string
45
+ content: string
46
+ }): Promise<string>
47
+ cleanupAction(): Promise<void>
48
+ toString(): string
49
+ #private
26
50
  }
27
51
  //# sourceMappingURL=ActionManager.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gesslar/bedoc",
3
- "version": "1.4.3",
3
+ "version": "1.4.4",
4
4
  "description": "Pluggable documentation engine for any language and format",
5
5
  "publisher": "gesslar",
6
6
  "main": "./src/core/Core.js",