narrat 3.5.0 → 3.6.0

package/dist/utils/data-helpers.d.ts

@@ -23,20 +23,21 @@ export declare function getModifiableDataPinia(): {
     scope: {
         [key: string]: any;
     };
-    config: import("../lib").Config;
+    config: import("../config/common-config").CommonConfig;
     gameOptions: {
         baseAssetsPath?: string | undefined;
         baseDataPath?: string | undefined;
-        configPath: string;
+        configPath?: string | undefined;
         scripts: {
             code: string;
             fileName: string;
             id: string;
+            type: "script";
         }[];
         logging?: boolean | undefined;
         debug?: boolean | undefined;
         container?: string | HTMLElement | undefined;
-        configs?: {
+        config?: {
             skillChecks?: string | {
                 options: {
                     extraDicePerLevel?: number | undefined;
@@ -59,8 +60,18 @@ export declare function getModifiableDataPinia(): {
                     skill: string;
                     difficulty: number;
                 }>;
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
             skills?: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
                 skills?: Record<string, {
                     hidden?: boolean | undefined;
                     name: string;
@@ -73,20 +84,43 @@ export declare function getModifiableDataPinia(): {
                     notifyLevelUp: boolean;
                 } | undefined;
             } | undefined;
+            items?: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
+                categories?: {
+                    title: string;
+                    id: string;
+                }[] | undefined;
+                items?: Record<string, {
+                    onUse?: {
+                        label: string;
+                        action: string;
+                    } | undefined;
+                    tag?: string | undefined;
+                    category?: string | undefined;
+                    showIfEmpty?: boolean | undefined;
+                    name: string;
+                    description: string;
+                    icon: string;
+                }> | undefined;
+            } | undefined;
             buttons?: string | {
                 clickableDuringScriptsByDefault?: boolean | undefined;
                 buttons: Record<string, {
                     text?: string | undefined;
+                    action?: string | undefined;
+                    tag?: string | undefined;
                     background?: string | undefined;
                     cssClass?: string | undefined;
                     anchor?: {
                         x: number;
                         y: number;
                     } | undefined;
-                    action?: string | undefined;
                     actionType?: string | undefined;
                     scriptClickable?: boolean | undefined;
-                    tag?: string | undefined;
                     enabled: boolean;
                     position: {
                         width?: number | undefined;
@@ -95,24 +129,11 @@ export declare function getModifiableDataPinia(): {
                         top: number;
                     };
                 }>;
-            } | undefined;
-            items?: string | {
-                categories?: {
-                    title: string;
-                    id: string;
-                }[] | undefined;
-                items?: Record<string, {
-                    tag?: string | undefined;
-                    onUse?: {
-                        label: string;
-                        action: string;
-                    } | undefined;
-                    category?: string | undefined;
-                    showIfEmpty?: boolean | undefined;
-                    name: string;
-                    description: string;
-                    icon: string;
-                }> | undefined;
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
             quests?: string | {
                 categories: {
@@ -136,6 +157,11 @@ export declare function getModifiableDataPinia(): {
                         description: string;
                     }>;
                 }>;
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
             tooltips?: string | {
                 options: {
@@ -159,98 +185,77 @@ export declare function getModifiableDataPinia(): {
                     description: string;
                     keywords: string[];
                 }[];
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
-            baseAssetsPath?: string | undefined;
-            baseDataPath?: string | undefined;
-            images?: Record<string, string> | undefined;
-            settings?: {
-                customSettings?: Record<string, ({
-                    description?: string | undefined;
-                    name: string;
-                } & {
-                    type: "number";
-                    maxValue: number;
-                    minValue: number;
-                    defaultValue: number;
-                    step: number;
-                }) | ({
-                    description?: string | undefined;
-                    name: string;
-                } & {
-                    type: "integer";
-                    maxValue: number;
-                    minValue: number;
-                    defaultValue: number;
-                    step: number;
-                }) | ({
-                    description?: string | undefined;
-                    name: string;
-                } & {
-                    type: "boolean";
-                    defaultValue: boolean;
-                }) | ({
-                    description?: string | undefined;
-                    name: string;
-                } & {
-                    type: "string";
-                    defaultValue: string;
-                })> | undefined;
-            } | undefined;
-            gameFlow?: {
-                labelToJumpOnScriptEnd?: string | undefined;
-            } | undefined;
-            dialogPanel?: {
-                width?: number | undefined;
-                height?: number | undefined;
-                animateText?: boolean | undefined;
-                textSpeed?: number | undefined;
-                timeBetweenLines?: number | undefined;
-                overlayMode?: boolean | undefined;
-                rightOffset?: number | undefined;
-                bottomOffset?: number | undefined;
-                hideDuringTransition?: boolean | undefined;
-                showAfterScriptEnd?: boolean | undefined;
-            } | undefined;
-            splashScreens?: {
-                engineSplashScreen?: {
-                    skip?: boolean | undefined;
-                    fadeDuration?: number | undefined;
-                    timeBeforeFadeout?: number | undefined;
-                    overrideText?: string | undefined;
-                    overrideLogo?: string | undefined;
-                } | undefined;
-                gameSplashScreen?: {
-                    startButtonText?: string | undefined;
-                } | undefined;
+            animations?: string | {
+                keyframes: Record<string, any[]>;
+                animations: Record<string, {
+                    options?: {
+                        fill?: string | undefined;
+                        delay?: number | undefined;
+                        duration?: number | undefined;
+                        direction?: string | undefined;
+                        easing?: string | undefined;
+                        endDelay?: number | undefined;
+                        iterationStart?: number | undefined;
+                        iterations?: number | undefined;
+                        keyframes?: any;
+                    } | undefined;
+                    keyframes: string | any[];
+                }>;
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
-            scripts?: string | string[] | undefined;
-            notifications?: {
-                alsoPrintInDialogue?: boolean | undefined;
-                timeOnScreen: number;
+            achievements?: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
+                categories?: {
+                    title: string;
+                    id: string;
+                }[] | undefined;
+                achievements?: Record<string, {
+                    icon?: string | undefined;
+                    category?: string | undefined;
+                    lockedIcon?: string | undefined;
+                    secret?: boolean | undefined;
+                    name: string;
+                    description: string;
+                }> | undefined;
             } | undefined;
-            achievements?: string | undefined;
-            interactionTags?: Record<string, {
-                onlyInteractOutsideOfScripts?: boolean | undefined;
-            }> | undefined;
-            transitions?: Record<string, {
-                delay?: number | undefined;
-                duration?: number | undefined;
-            }> | undefined;
-            menuButtons?: Record<string, {
-                cssClass?: string | undefined;
-                text: string;
-            }> | undefined;
-            debugging?: {
-                showScriptFinishedMessage?: boolean | undefined;
+            scripts?: string | string[] | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             } | undefined;
-            saves?: {
-                runOnReload?: string | undefined;
-                slots: number;
-                mode: string;
+            choices?: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
+                choiceTextTemplate?: string | undefined;
+                choicePrompts?: Record<string, {
+                    cssClass?: string | undefined;
+                    textTemplate?: string | undefined;
+                }> | undefined;
             } | undefined;
-            choices?: string | undefined;
-            animations?: string | undefined;
             audio: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
                 options: {
                     volume?: number | undefined;
                     defaultMusic?: string | undefined;
@@ -299,8 +304,18 @@ export declare function getModifiableDataPinia(): {
                     }> | undefined;
                     name: string;
                 }>;
+            } | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
             };
             screens: string | {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
                 screens?: Record<string, {
                     video?: {
                         loop?: boolean | undefined;
@@ -308,16 +323,16 @@ export declare function getModifiableDataPinia(): {
                     } | undefined;
                     buttons?: (string | ({
                         text?: string | undefined;
+                        action?: string | undefined;
+                        tag?: string | undefined;
                         background?: string | undefined;
                         cssClass?: string | undefined;
                         anchor?: {
                             x: number;
                             y: number;
                         } | undefined;
-                        action?: string | undefined;
                         actionType?: string | undefined;
                         scriptClickable?: boolean | undefined;
-                        tag?: string | undefined;
                         enabled: boolean;
                         position: {
                             width?: number | undefined;
@@ -331,39 +346,132 @@ export declare function getModifiableDataPinia(): {
                     background: string;
                 }> | undefined;
             };
-            gameTitle: string;
-            saveFileName: string;
-            layout: {
-                minTextWidth?: number | undefined;
-                defaultFontSize?: number | undefined;
-                backgrounds: {
-                    width: number;
-                    height: number;
-                };
-                dialogBottomPadding: string | number;
-                verticalLayoutThreshold: number;
-                portraits: {
-                    offset?: {
-                        landscape?: {
-                            right: number;
-                            bottom: number;
-                        } | undefined;
-                        portrait?: {
-                            right: number;
-                            bottom: number;
-                        } | undefined;
+            common: {
+                code: string;
+                fileName: string;
+                id: string;
+                type: "yaml";
+            } | {
+                baseAssetsPath?: string | undefined;
+                baseDataPath?: string | undefined;
+                images?: Record<string, string> | undefined;
+                settings?: {
+                    customSettings?: Record<string, ({
+                        description?: string | undefined;
+                        name: string;
+                    } & {
+                        type: "number";
+                        defaultValue: number;
+                        step: number;
+                        minValue: number;
+                        maxValue: number;
+                    }) | ({
+                        description?: string | undefined;
+                        name: string;
+                    } & {
+                        type: "integer";
+                        defaultValue: number;
+                        step: number;
+                        minValue: number;
+                        maxValue: number;
+                    }) | ({
+                        description?: string | undefined;
+                        name: string;
+                    } & {
+                        type: "boolean";
+                        defaultValue: boolean;
+                    }) | ({
+                        description?: string | undefined;
+                        name: string;
+                    } & {
+                        type: "string";
+                        defaultValue: string;
+                    })> | undefined;
+                } | undefined;
+                gameFlow?: {
+                    labelToJumpOnScriptEnd?: string | undefined;
+                } | undefined;
+                dialogPanel?: {
+                    width?: number | undefined;
+                    height?: number | undefined;
+                    animateText?: boolean | undefined;
+                    textSpeed?: number | undefined;
+                    timeBetweenLines?: number | undefined;
+                    overlayMode?: boolean | undefined;
+                    rightOffset?: number | undefined;
+                    bottomOffset?: number | undefined;
+                    hideDuringTransition?: boolean | undefined;
+                    showAfterScriptEnd?: boolean | undefined;
+                } | undefined;
+                splashScreens?: {
+                    engineSplashScreen?: {
+                        skip?: boolean | undefined;
+                        fadeDuration?: number | undefined;
+                        timeBeforeFadeout?: number | undefined;
+                        overrideText?: string | undefined;
+                        overrideLogo?: string | undefined;
                     } | undefined;
-                    width: number;
-                    height: number;
+                    gameSplashScreen?: {
+                        startButtonText?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                notifications?: {
+                    alsoPrintInDialogue?: boolean | undefined;
+                    timeOnScreen: number;
+                } | undefined;
+                interactionTags?: Record<string, {
+                    onlyInteractOutsideOfScripts?: boolean | undefined;
+                }> | undefined;
+                transitions?: Record<string, {
+                    delay?: number | undefined;
+                    duration?: number | undefined;
+                }> | undefined;
+                menuButtons?: Record<string, {
+                    cssClass?: string | undefined;
+                    text: string;
+                }> | undefined;
+                debugging?: {
+                    showScriptFinishedMessage?: boolean | undefined;
+                } | undefined;
+                saves?: {
+                    runOnReload?: string | undefined;
+                    slots: number;
+                    mode: string;
+                } | undefined;
+                gameTitle: string;
+                saveFileName: string;
+                layout: {
+                    minTextWidth?: number | undefined;
+                    defaultFontSize?: number | undefined;
+                    backgrounds: {
+                        width: number;
+                        height: number;
+                    };
+                    dialogBottomPadding: string | number;
+                    verticalLayoutThreshold: number;
+                    portraits: {
+                        offset?: {
+                            landscape?: {
+                                right: number;
+                                bottom: number;
+                            } | undefined;
+                            portrait?: {
+                                right: number;
+                                bottom: number;
+                            } | undefined;
+                        } | undefined;
+                        width: number;
+                        height: number;
+                    };
                 };
+                hudStats: Record<string, {
+                    minValue?: number | undefined;
+                    maxValue?: number | undefined;
+                    name: string;
+                    icon: string;
+                    startingValue: number;
+                }>;
             };
-            hudStats: Record<string, {
-                maxValue?: number | undefined;
-                minValue?: number | undefined;
-                name: string;
-                icon: string;
-                startingValue: number;
-            }>;
         } | undefined;
     };
     baseSettings: {

package/dist/utils/type-utils.d.ts

@@ -1,2 +1,5 @@
 export declare const generateObjectFromList: <T extends readonly string[]>(list: T) => { [K in T[number]]: K; };
 export declare const isPromise: <T>(value: any) => value is Promise<T>;
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "narrat narrative engine",
   "main": "dist/narrat.umd.js",
   "module": "dist/narrat.es.js",
@@ -61,7 +61,7 @@
     "vue": "^3.3.4"
   },
   "dependencies": {
-    "@sinclair/typebox": "^0.29.1",
+    "@sinclair/typebox": "^0.31.18",
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
     "clone-deep": "^4.0.1",
@@ -100,6 +100,7 @@
     "kolorist": "^1.5.1",
     "pinia": "^2.1.4",
     "prettier": "^3.0.0",
+    "rollup-plugin-visualizer": "^5.9.2",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",
     "ts-prune": "^0.10.3",
@@ -113,7 +114,7 @@
     "vite-plugin-windicss": "^1.9.0",
     "vitest": "^0.33.0",
     "vue": "^3.3.4",
-    "vue-tsc": "^1.8.15",
+    "vue-tsc": "^1.8.22",
     "windicss": "^3.5.6"
   }
 }