narrat 0.11.6 → 1.0.0

package/lib/types/state.d.ts

@@ -1,99 +1,3 @@
-import { AppOptions } from '..';
-import { Parser } from './parser';
-export declare type DialogCallback = (choice: number) => void;
-export interface MachineStack {
-    currentIndex: number;
-    branch: Parser.Branch;
-    label: string;
-}
-export interface DialogKey {
-    speaker: string;
-    text: string;
-    pose?: string;
-    choices?: DialogChoice[];
-    interactive: boolean;
-    id: string;
-}
-export interface DialogChoice {
-    choice: string;
-    originalIndex: number;
-    allowed: boolean;
-}
-export interface SkillState {
-    level: number;
-    xp: number;
-}
-export interface SkillsState {
-    [key: string]: SkillState;
-}
-export interface DataState {
-    [key: string]: any;
-}
-export interface SkillCheckState {
-    passed: boolean;
-    available: boolean;
-}
 export interface Vue {
     $mq: 'sm' | 'md' | 'lg';
 }
-export interface NarratState {
-    machine: {
-        stack: MachineStack[];
-        script: Parser.ParsedScript;
-        data: DataState;
-    };
-    skillChecks: {
-        [key: string]: SkillCheckState;
-    };
-    buttons: ButtonsState;
-    dialog: DialogKey[];
-    count: number;
-    ready: boolean;
-    skills: SkillsState;
-    lastLabel: string;
-    playing: boolean;
-    currentScreen: string;
-    rendering: RenderingState;
-    hudStats: HudStatsState;
-    audio: {
-        currentMusic?: string;
-        musicHowlId?: number;
-    };
-    errors: ErrorState[];
-    playTime: {
-        start: number;
-        previousPlaytime: number;
-    };
-    notifications: {
-        [key: string]: NotificationState;
-    };
-    options: AppOptions;
-    flowState: 'menu' | 'playing';
-    openModal: string | false;
-    paused: boolean;
-}
-export interface HudStatsState {
-    [key: string]: HudStat;
-}
-export declare type HudStat = number;
-export interface NotificationState {
-    text: string;
-}
-export interface ButtonsState {
-    [key: string]: {
-        enabled: boolean;
-    };
-}
-export interface RenderingState {
-    screenWidth: number;
-    screenHeight: number;
-    canvasWidth: number;
-    canvasHeight: number;
-    renderRatio: number;
-    topOffset: number;
-    leftOffset: number;
-    layoutMode: 'horizontal' | 'vertical';
-}
-export interface ErrorState {
-    text: string;
-}

package/lib/utils/audio-loader.d.ts

@@ -1,14 +1,12 @@
 import { Config, MusicConfig, AudioConfig } from '../config';
 import { Howl } from 'howler';
-import { State } from 'vue';
-import { ActionContext, Commit } from 'vuex';
 export declare const audio: {
     [key: string]: Howl;
 };
 export declare function loadAudioAssets(config: Config): Promise<void[]>;
 export declare function loadAudio(key: string, config: AudioConfig | MusicConfig): Promise<void>;
-export declare function changeMusic(ctx: ActionContext<State, State>, newMusic: string): Promise<void>;
-export declare function playAudio(commit: Commit, key: string): number;
+export declare function changeMusic(newMusic: string): Promise<void>;
+export declare function playAudio(key: string): number;
 export declare function getAudio(key: string): Howl | undefined;
-export declare function stopAudio(commit: Commit, key: string): void;
-export declare function pauseAudio(commit: Commit, key: string): void;
+export declare function stopAudio(key: string): void;
+export declare function pauseAudio(key: string): void;

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

@@ -1,9 +1,8 @@
-import { State } from 'vue';
 export declare function findDataHelper<T>(sourceObj: any, path: string): [T, string];
 export declare function setDataHelper<T>(sourceObj: any, path: string, value: T): void;
 export declare function addDataHelper<T>(sourceObj: any, path: string, value: T): void;
-export declare function getModifiableData(state: State): {
-    data: import("../types/state").DataState;
-    skills: import("../types/state").SkillsState;
-    buttons: import("../types/state").ButtonsState;
+export declare function getModifiableDataPinia(): {
+    data: import("@/stores/vm-store").DataState;
+    skills: import("@/stores/skills").SkillsState;
+    buttons: import("@/stores/screens-store").ButtonsState;
 };

package/lib/utils/error-handling.d.ts

@@ -1,4 +1,3 @@
 import { ParserContext } from '@/vm/vm-parser';
-import { Commit } from 'vuex';
-export declare function parserError(commit: Commit, ctx: ParserContext, line: number, text: string): void;
-export declare function error(commit: Commit, text: string): void;
+export declare function parserError(ctx: ParserContext, line: number, text: string): void;
+export declare function error(text: string): void;

package/lib/utils/skillchecks.d.ts

@@ -1,13 +1,10 @@
 import { SkillCheckParams } from '@/vm/vm-helpers';
-import { SkillCheckState } from '@/types/state';
-import { State } from 'vue';
-import { ActionContext } from 'vuex';
+import { SkillCheckState } from '@/stores/skills';
 export declare function createSkillCheckState(): SkillCheckState;
-export declare function getSkillCheckState(ctx: ActionContext<State, State>, skillCheckId: string): SkillCheckState;
+export declare function getSkillCheckState(skillCheckId: string): SkillCheckState;
 export declare function getSkillCheckDifficultyScore(value: number, level: number): number;
 export declare function getSkillCheckDifficultyText(value: number, level: number): string;
-export declare function getSkillCheckText({ context, skill, skillCheckId, value, }: {
-    context: ActionContext<State, State>;
+export declare function getSkillCheckText({ skill, skillCheckId, value, }: {
     skill: string;
     skillCheckId: string;
     value: number;
@@ -15,9 +12,9 @@ export declare function getSkillCheckText({ context, skill, skillCheckId, value,
     difficultyText: string;
     allowed: boolean;
 };
-export declare function getPassiveSkillCheckText(ctx: ActionContext<State, State>, success: boolean, params: SkillCheckParams): string;
-export declare function calculateSkillCheckRoll(state: State, skill: string): {
+export declare function getPassiveSkillCheckText(success: boolean, params: SkillCheckParams): string;
+export declare function calculateSkillCheckRoll(skill: string): {
     roll: number;
     unmodifiedRoll: number;
 };
-export declare function resolveSkillCheck(state: State, params: SkillCheckParams): boolean;
+export declare function resolveSkillCheck(params: SkillCheckParams): boolean;

package/lib/utils/string-helpers.d.ts

@@ -1,3 +1 @@
-import { State } from 'vue';
-import { Store } from 'vuex';
-export declare function processText(store: Store<State>, text: string): string;
+export declare function processText(text: string): string;

package/lib/vm/commands/choice.d.ts

@@ -1,7 +1,5 @@
-import { State } from 'vue';
-import { ActionContext } from 'vuex';
 import { CommandPlugin, CommandRunner } from './command-plugin';
 import { Parser } from '@/types/parser';
 export declare const choice: CommandRunner;
-export declare function runChoice(context: ActionContext<State, State>, cmd: Parser.Command): Promise<void>;
+export declare function runChoice(cmd: Parser.Command): Promise<void>;
 export declare const choicePlugin: CommandPlugin;

package/lib/vm/commands/command-plugin.d.ts

@@ -1,8 +1,7 @@
 import { Parser } from '../../types/parser';
-import { DialogChoice, NarratState } from '../../types/state';
-import { ActionContext } from 'vuex';
 import { ParserContext } from '../vm-parser';
-export declare type CommandRunner = (context: ActionContext<NarratState, NarratState>, cmd: Parser.Command, choices?: DialogChoice[]) => Promise<void>;
+import { DialogChoice } from '@/stores/dialog-store';
+export declare type CommandRunner = (cmd: Parser.Command, choices?: DialogChoice[]) => Promise<void>;
 export declare type CommandParserFunction = (ctx: CommandParsingContext) => void;
 export declare type ProcessCommandsFunction = (ctx: ParserContext, lines: Parser.Line[], parentLine: Parser.Line | undefined) => Parser.Branch;
 export interface CommandParsingContext {

package/lib/vm/vm-helpers.d.ts

@@ -1,8 +1,6 @@
-import { AddDialogParams } from '@/store';
+import { AddDialogParams } from '@/stores/dialog-store';
 import { Parser } from '@/types/parser';
-import { State } from 'vue';
-import { ActionContext, Commit } from 'vuex';
-export declare function processSkillCheck(ctx: ActionContext<State, State>, skillcheck: Parser.SkillCheckOptions): boolean;
+export declare function processSkillCheck(skillcheck: Parser.SkillCheckOptions): boolean;
 export interface SkillCheckParams {
     skill: string;
     value: number;
@@ -10,9 +8,9 @@ export interface SkillCheckParams {
     success?: string;
     failure?: string;
 }
-export declare function runSkillCheck(ctx: ActionContext<State, State>, params: SkillCheckParams): boolean;
-export declare function runConditionCommand(ctx: ActionContext<State, State>, command: Parser.Command): Parser.Branch | undefined;
-export declare function writeText(ctx: ActionContext<State, State>, text: string): void;
-export declare function runCondition(ctx: ActionContext<State, State>, condition: string): boolean;
-export declare function textCommand(commit: Commit, dialog: AddDialogParams): Promise<void>;
+export declare function runSkillCheck(params: SkillCheckParams): boolean;
+export declare function runConditionCommand(command: Parser.Command): Parser.Branch | undefined;
+export declare function writeText(text: string): void;
+export declare function runCondition(condition: string): boolean;
+export declare function textCommand(dialog: AddDialogParams): Promise<void>;
 export declare function getLine(lines: Parser.Line[], index: number): Parser.Line;

package/lib/vm/vm.d.ts

@@ -1,10 +1,7 @@
-import { ActionContext } from 'vuex';
-import { State } from 'vue';
-import { DialogChoice } from '@/types/state';
 import { CommandPlugin } from './commands/command-plugin';
 import { NarratPluginObject } from '@/exports/plugins';
 import { Parser } from '@/types/parser';
-export declare function runLine(context: ActionContext<State, State>): Promise<void>;
+import { DialogChoice } from '@/stores/dialog-store';
 export declare class VM {
     plugins: NarratPluginObject[];
     commands: {
@@ -15,7 +12,6 @@ export declare class VM {
     callHook(hookName: string, ...args: any[]): void;
 }
 export declare const vm: VM;
-export declare function runCommand(context: ActionContext<State, State>, cmd: Parser.Command, choices?: DialogChoice[]): Promise<void>;
-export declare function playerAnswered(context: ActionContext<State, State>, choiceIndex: number): Promise<void>;
-export declare function nextLine(ctx: ActionContext<State, State>): Promise<any>;
-export declare function finishGame({ commit, state }: ActionContext<State, State>): void;
+export declare function runCommand(cmd: Parser.Command, choices?: DialogChoice[]): Promise<void>;
+export declare function playerAnswered(choiceIndex: number): Promise<void>;
+export declare function finishGame(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "0.11.6",
+  "version": "1.0.0",
   "description": "narrat narrative engine",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -66,13 +66,13 @@
     "snowpack": "^3.8.6",
     "tailwindcss": "^2.0.2",
     "typescript": "^4.2.3",
-    "vue": "^3.2.2",
-    "vuex": "^4.0.0-rc.2"
+    "vue": "^3.2.37",
+    "pinia": "^2.0.14"
   },
   "peerDependencies": {
     "es6-promise": "^4.2.8",
-    "vue": "^3.0.4",
-    "vuex": "^4.0.0-rc.2"
+    "vue": "^3.2.37",
+    "pinia": "^2.0.14"
   },
   "dependencies": {
     "autoprefixer": "^10.2.6",