chore: Better typedoc generation

Author: shdwmtr

.vscode/tasks.json

@@ -22,6 +22,14 @@
 			"label": "Build Millennium SDK",
 			"detail": "build the Millennium software developement kit",
 			"dependsOn": ["Install Node Modules"]
+		},
+		{
+			"type": "npm",
+			"script": "docs",
+			"group": "build",
+			"problemMatcher": [],
+			"label": "Build Millennium SDK Docs",
+			"detail": "build the Millennium software developement kit documentation"
 		}
 	]
 }

package.json

@@ -14,7 +14,8 @@
 		"husky": "^9.1.7",
 		"lerna": "^8.2.2",
 		"typedoc": "^0.28.5",
-		"typedoc-plugin-markdown": "^4.6.4"
+		"typedoc-plugin-markdown": "^4.6.4",
+		"typedoc-plugin-frontmatter": "^1.3.0"
 	},
 	"pnpm": {
 		"peerDependencyRules": {

pnpm-lock.yaml

@@ -2,6 +2,7 @@
 import json, os
 import Millennium # type: ignore[import]
 import builtins
+import enum
 
 config_path = os.path.join(os.getenv("MILLENNIUM__CONFIG_PATH"), "plugins.json")
 
@@ -124,6 +125,9 @@ def __init__(cls, name, bases, class_dict):
         else:
             raise Exception("Millennium only allows one instance of plugin settings.")
 
+    def __get_raw__(self, name):
+        return super().__getattribute__(name)
+
     def __getattribute__(self, name, *args, **kwargs):
         attributeValue = super().__getattribute__(name)
         returnValue = None
@@ -155,13 +159,28 @@ def __setattr__(self, targetKey, newValue):
         return super().__setattr__(targetKey, newValue)
 
 
+class CallbackLocation(enum.Enum):
+    LOCAL = "local"
+    EXTERNAL = "external"
+
+class OnAfterChangeCallback:
+    def __init__(self, func):
+        self.func = func
+
+    def __call__(self, *args, **kwargs):
+        print("Before the function call")
+        result = self.func(*args, **kwargs)
+        print("After the function call")
+        return result
+
 class DefineSetting:
-    def __init__(self, name, description, style, default, step=None, range=None):
+    def __init__(self, name, style, default, description=None, configurable=None, step=None, range=None):
         self.name = name
-        self.desc = description
+        self.desc = description or "No description yet."
         self.type = type(style)
         self.instance = style
         self.default = default
+        self.configurable = configurable or True
 
     def _get_info(self):
         return (self.name, self.desc, self.type, self.range)
@@ -196,16 +215,32 @@ def hookedFunction(_, *args, **kwargs):
             "type": self.type,
             "default": self.default,
             "instance": self.instance,
+            "configurable": self.configurable,
         }
 
         return hookedFunction
 
 
+
+
 def UpdateSettingsValue(name, value):
+    previousValue = getattr(__builtins__["__millennium_plugin_settings_do_not_use__"], name)()
+
+    def InvokeOnCallback():
+        pluginSettings = __builtins__["__millennium_plugin_settings_do_not_use__"]
+
+        for func_name in dir(pluginSettings):
+            func = getattr(pluginSettings, func_name)
+
+            if func.__class__ == OnAfterChangeCallback:
+                func(pluginSettings, name, value, previousValue, CallbackLocation.LOCAL)
+
     settingsStore = GetPluginSettingsStore()
     settingsStore[name] = value
     SetPluginSettingsStore(settingsStore)
 
+    InvokeOnCallback()
+
 builtins.__update_settings_value__ = UpdateSettingsValue
 
 def ParsePluginSettings():
@@ -221,11 +256,13 @@ def ParsePluginSettings():
                 "name": attribute._metadata["name"],
                 "desc": attribute._metadata["desc"],
                 "value": attribute(),
-                "functionName": attributeName
+                "functionName": attributeName,
+                "configurable": attribute._metadata["configurable"],
             }
-            if isinstance(attribute._metadata["type"], tuple) and issubclass(attribute._metadata["type"][0], DropDown):
-                setting["options"] = attribute._metadata["type"][1]
-                setting["type"] = attribute._metadata["type"][0].__name__
+
+            if issubclass(attribute._metadata["type"], DropDown):
+                setting["options"] = attribute._metadata["instance"].items
+                setting["type"] = attribute._metadata["type"].__name__
 
             elif issubclass(attribute._metadata["type"], (NumberTextInput, FloatTextInput)):
                 setting["range"] = attribute._metadata["instance"].range

python-packages/core-utils/MillenniumUtils/__init__.py

@@ -1,12 +1,13 @@
 {
 	"entryPoints": ["typescript-packages/client/src/index.ts", "typescript-packages/browser/src/index.ts"],
 	"out": "docs",
-	"plugin": ["typedoc-plugin-markdown"],
+	"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"],
 	"readme": "README.md",
 	"includeVersion": true,
 	"tsconfig": "tsconfig.base.json",
 	"expandObjects": true,
 	"enumMembersFormat": "table",
 	"useCodeBlocks": true,
-	"expandParameters": false
+	"expandParameters": false,
+	"frontmatterCommentTags": ["component"]
 }

typedoc.json

@@ -4,5 +4,5 @@ import { DialogButton, DialogButtonProps } from './Dialog';
 
 export interface ButtonProps extends DialogButtonProps {}
 
-// Button isn't exported, so call DialogButton to grab it
+/** @component React Components */
 export const Button = (DialogButton as any)?.render({}).type as FC<ButtonProps>;

typescript-packages/client/src/components/Button.ts

@@ -5,12 +5,11 @@ import { ItemProps } from './Item';
 import { createPropListRegex } from '../utils';
 
 export interface ButtonItemProps extends ItemProps {
-  onClick?(e: MouseEvent): void;
-  disabled?: boolean;
+	onClick?(e: MouseEvent): void;
+	disabled?: boolean;
 }
-const buttonItemRegex = createPropListRegex(["highlightOnFocus", "childrenContainerWidth"], false);
+const buttonItemRegex = createPropListRegex(['highlightOnFocus', 'childrenContainerWidth'], false);
+/** @component React Components */
 export const ButtonItem = Object.values(CommonUIModule).find(
-  (mod: any) =>
-    (mod?.render?.toString && buttonItemRegex.test(mod.render.toString())) || 
-    mod?.render?.toString?.().includes('childrenContainerWidth:"min"'),
+	(mod: any) => (mod?.render?.toString && buttonItemRegex.test(mod.render.toString())) || mod?.render?.toString?.().includes('childrenContainerWidth:"min"'),
 ) as FC<ButtonItemProps>;

typescript-packages/client/src/components/ButtonItem.ts

@@ -3,23 +3,21 @@ import { HTMLAttributes, ReactNode, RefAttributes, FC } from 'react';
 import { Export, findModuleExport } from '../webpack';
 
 export interface CarouselProps extends HTMLAttributes<HTMLDivElement> {
-  autoFocus?: boolean;
-  enableBumperPaging?: boolean;
-  fnDoesItemTakeFocus?: (...unknown: any[]) => boolean;
-  fnGetColumnWidth?: (...unknown: any[]) => number;
-  fnGetId?: (id: number) => number;
-  fnItemRenderer?: (id: number, ...unknown: any[]) => ReactNode;
-  fnUpdateArrows?: (...unknown: any[]) => any;
-  initialColumn?: number;
-  nHeight?: number;
-  nIndexLeftmost?: number;
-  nItemHeight?: number;
-  nItemMarginX?: number;
-  nNumItems?: number;
-  name?: string;
-  scrollToAlignment?: 'center';
+	autoFocus?: boolean;
+	enableBumperPaging?: boolean;
+	fnDoesItemTakeFocus?: (...unknown: any[]) => boolean;
+	fnGetColumnWidth?: (...unknown: any[]) => number;
+	fnGetId?: (id: number) => number;
+	fnItemRenderer?: (id: number, ...unknown: any[]) => ReactNode;
+	fnUpdateArrows?: (...unknown: any[]) => any;
+	initialColumn?: number;
+	nHeight?: number;
+	nIndexLeftmost?: number;
+	nItemHeight?: number;
+	nItemMarginX?: number;
+	nNumItems?: number;
+	name?: string;
+	scrollToAlignment?: 'center';
 }
-
-export const Carousel = findModuleExport((e: Export) => e.render?.toString().includes('setFocusedColumn:')) as FC<
-  CarouselProps & RefAttributes<HTMLDivElement>
->;
+/** @component React Components */
+export const Carousel = findModuleExport((e: Export) => e.render?.toString().includes('setFocusedColumn:')) as FC<CarouselProps & RefAttributes<HTMLDivElement>>;

typescript-packages/client/src/components/Carousel.ts

@@ -3,12 +3,11 @@ import { FC, ReactNode } from 'react';
 import { Export, findModuleExport } from '../webpack';
 
 export interface ControlsListProps {
-  alignItems?: 'left' | 'right' | 'center';
-  spacing?: 'standard' | 'extra';
-  children?: ReactNode;
+	alignItems?: 'left' | 'right' | 'center';
+	spacing?: 'standard' | 'extra';
+	children?: ReactNode;
 }
-
+/** @component React Components */
 export const ControlsList: FC<ControlsListProps> = findModuleExport(
-  (e: Export) =>
-    e?.toString && e.toString().includes('().ControlsListChild') && e.toString().includes('().ControlsListOuterPanel'),
+	(e: Export) => e?.toString && e.toString().includes('().ControlsListChild') && e.toString().includes('().ControlsListOuterPanel'),
 );

typescript-packages/client/src/components/ControlsList.ts

@@ -65,23 +65,32 @@ const MappedDialogDivs = new Map(
 	}),
 );
 
+/** @component React Components */
 export const DialogHeader = MappedDialogDivs.get('DialogHeader') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogSubHeader = MappedDialogDivs.get('DialogSubHeader') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogFooter = MappedDialogDivs.get('DialogFooter') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogLabel = MappedDialogDivs.get('DialogLabel') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogBodyText = MappedDialogDivs.get('DialogBodyText') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogBody = MappedDialogDivs.get('DialogBody') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogControlsSection = MappedDialogDivs.get('DialogControlsSection') as FC<DialogCommonProps>;
+/** @component React Components */
 export const DialogControlsSectionHeader = MappedDialogDivs.get('DialogControlsSectionHeader') as FC<DialogCommonProps>;
 
+/** @component React Components */
 export const DialogButtonPrimary = Object.values(CommonUIModule).find((mod: any) =>
 	mod?.render?.toString()?.includes('"DialogButton","_DialogLayout","Primary"'),
 ) as FC<DialogButtonProps>;
 
+/** @component React Components */
 export const DialogButtonSecondary = Object.values(CommonUIModule).find((mod: any) =>
 	mod?.render?.toString()?.includes('"DialogButton","_DialogLayout","Secondary"'),
 ) as FC<DialogButtonProps>;
 
-// This is the "main" button. The Primary can act as a submit button,
-// therefore secondary is chosen (also for backwards comp. reasons)
+/** @component React Components */
 export const DialogButton = DialogButtonSecondary;

typescript-packages/client/src/components/Dialog.ts

@@ -5,32 +5,29 @@ import { DialogCommonProps } from './Dialog';
 import { FooterLegendProps } from './FooterLegend';
 
 export interface DialogCheckboxProps extends DialogCommonProps, FooterLegendProps {
-  onChange?(checked: boolean): void;
-  label?: ReactNode;
-  description?: ReactNode;
-  disabled?: boolean;
-  tooltip?: string;
-  color?: string;
-  highlightColor?: string;
-  bottomSeparator?: 'standard' | 'thick' | 'none';
-  controlled?: boolean;
-  checked?: boolean;
-  onClick?(evt: Event): void;
+	onChange?(checked: boolean): void;
+	label?: ReactNode;
+	description?: ReactNode;
+	disabled?: boolean;
+	tooltip?: string;
+	color?: string;
+	highlightColor?: string;
+	bottomSeparator?: 'standard' | 'thick' | 'none';
+	controlled?: boolean;
+	checked?: boolean;
+	onClick?(evt: Event): void;
 }
 
+/** @component React Components */
 export const DialogCheckbox = Object.values(
-  findModule((m: any) => {
-    if (typeof m !== 'object') return false;
-    for (const prop in m) {
-      if (m[prop]?.prototype?.GetPanelElementProps) return true;
-    }
-    return false;
-  }),
+	findModule((m: any) => {
+		if (typeof m !== 'object') return false;
+		for (const prop in m) {
+			if (m[prop]?.prototype?.GetPanelElementProps) return true;
+		}
+		return false;
+	}),
 ).find(
-  (m: any) =>
-    m.contextType &&
-    m.prototype?.render.toString().includes('fallback:') &&
-    m?.prototype?.SetChecked &&
-    m?.prototype?.Toggle &&
-    m?.prototype?.GetPanelElementProps,
+	(m: any) =>
+		m.contextType && m.prototype?.render.toString().includes('fallback:') && m?.prototype?.SetChecked && m?.prototype?.Toggle && m?.prototype?.GetPanelElementProps,
 ) as FC<DialogCheckboxProps>;