narrat 3.4.0 → 3.5.0

package/dist/plugins/narrat-themes/NarratThemesPlugin.d.ts

@@ -0,0 +1,40 @@
+import { Config } from '../../config/config-output';
+import { NarratPlugin } from '../NarratPlugin';
+import { CommandPlugin } from '../../vm/commands/command-plugin';
+export type BaseTheme = {
+    id: string;
+    extendedConfig?: Partial<Config>;
+};
+export type InlineTheme = BaseTheme & {
+    css: string;
+};
+export type ExternalTheme = BaseTheme & {
+    cssPath: string;
+};
+export type Theme = InlineTheme | ExternalTheme;
+export interface NarratThemesPluginOptions {
+    defaultTheme?: string;
+    themes?: Theme[];
+}
+export type ThemeTag = HTMLLinkElement | HTMLStyleElement;
+export declare class NarratThemesPlugin extends NarratPlugin {
+    defaultTheme?: string;
+    themes: Theme[];
+    activeTheme?: {
+        id: string;
+        themeTag: ThemeTag;
+    };
+    customCommands: CommandPlugin<any>[];
+    initialConfig: Config;
+    constructor(options?: NarratThemesPluginOptions);
+    onNarratSetup(): void;
+    addTheme(theme: Theme): void;
+    createChangeThemeCommand(): CommandPlugin<any>;
+    changeTheme(themeId: string): void;
+    findTheme(themeId: string): Theme;
+    setTheme(theme: Theme): void;
+    createThemeTag(theme: Theme): ThemeTag;
+    isInlineTheme(theme: Theme): theme is InlineTheme;
+    isExternalTheme(theme: Theme): theme is ExternalTheme;
+    removeCurrentTheme(): void;
+}

package/dist/plugins/narrat-themes/fun-theme/index.d.ts

@@ -0,0 +1,2 @@
+import { Theme } from '../NarratThemesPlugin';
+export declare const funTheme: Theme;

package/dist/plugins/narrat-themes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fun-theme';
+export * from './text-only';

package/dist/plugins/narrat-themes/text-only/index.d.ts

@@ -0,0 +1,2 @@
+import { Theme } from '../NarratThemesPlugin';
+export declare const textOnlyTheme: Theme;

package/dist/plugins/plugins.d.ts

@@ -0,0 +1,69 @@
+import { NarratPlugin } from '../plugins/NarratPlugin';
+import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
+import type { CommandRunner } from '../vm/commands/command-plugin';
+import { StoreDefinition } from 'pinia';
+import { MenuState, MenuTabState } from '../stores/menu-store';
+import { CustomSetting } from '../config/settings-config';
+export type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+export interface NarratCustomStoreActions {
+    save?: () => any;
+    load?: (data: any) => void;
+    setup?: () => Promise<void>;
+    start?: () => void;
+    reset: () => void;
+}
+export type UseCustomStore = StoreDefinition<string, any, any, NarratCustomStoreActions>;
+export interface CustomStores {
+    [key: string]: UseCustomStore;
+}
+export interface CustomMenuButton {
+    menuId: string;
+    config: MenuState;
+    components: {
+        [key: string]: any;
+    };
+}
+export interface CustomMenuTab {
+    menuId: string;
+    config: MenuTabState;
+    component: any;
+}
+export type NarratPluginObject<T> = {
+    pluginId: string;
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin<T>[];
+    customStores?: CustomStores;
+    customMenuButtons?: CustomMenuButton[];
+    customMenuTabs?: CustomMenuTab[];
+    startMenuButtons?: CustomStartMenuButton[];
+    customSettings?: Record<string, CustomSetting>;
+    save?: () => any;
+    load?: (data: any) => void;
+    reset?: () => void;
+    loadingPromises?: Promise<any>[];
+};
+/**
+ * Custom buttons that get added to the start menu (where the New Game etc buttons are)
+ * Action option is to provide a function to run on click
+ * popupComponent option is to provide a component to display in a modal window on click (for custom pieces of UI)
+ */
+export interface CustomStartMenuButton {
+    id: string;
+    text: string;
+    action?: () => void;
+    popupComponent?: {
+        name: string;
+        component: any;
+    };
+}
+declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
+declare function addCommand<T>(command: CommandPlugin<T>): void;
+export { CommandRunner };
+export { CommandPlugin, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "narrat narrative engine",
   "main": "dist/narrat.umd.js",
   "module": "dist/narrat.es.js",