narrat 0.10.0 → 0.11.2

package/lib/plugins/NarratPlugin.d.ts

@@ -0,0 +1,11 @@
+import { NarratPluginObject } from '@/plugins';
+export declare class NarratPlugin implements NarratPluginObject {
+    onPageLoaded(): void;
+    onNarratSetup(): void;
+    onAppMounted(): void;
+    onAssetsLoaded(): void;
+    onGameSetup(): void;
+    onGameStart(): void;
+    onGameMounted(): void;
+    onGameDismounted(): void;
+}

package/lib/plugins.d.ts

@@ -0,0 +1,22 @@
+import { State } from 'vue';
+import { ActionContext } from 'vuex';
+import { NarratPlugin } from './plugins/NarratPlugin';
+import { CommandPlugin, generateParser } from './vm/commands/command-plugin';
+import type { CommandRunner } from './vm/commands/command-plugin';
+export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+declare type NarratPluginObject = {
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin[];
+};
+declare function registerPlugin(plugin: NarratPluginObject): void;
+declare function addCommand(command: CommandPlugin): void;
+export declare type NarratActionContext = ActionContext<State, State>;
+export { CommandRunner };
+export { CommandPlugin, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };

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

@@ -1,4 +1,4 @@
-import { ParserContext } from '@/renpy/renpy-parser';
+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;

package/lib/utils/skillchecks.d.ts

@@ -1,4 +1,4 @@
-import { SkillCheckParams } from '@/renpy/renpy-helpers';
+import { SkillCheckParams } from '@/vm/vm-helpers';
 import { SkillCheckState } from '@/types/vuex';
 import { State } from 'vue';
 import { ActionContext } from 'vuex';

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const add: CommandRunner;
+export declare const addPlugin: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const addLevelPlugin: CommandPlugin;

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const addStatRunner: CommandRunner;
+export declare const addStatPlugin: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const addXpPlugin: CommandPlugin;

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

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

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const clearDialog: CommandRunner;
+export declare const clearDialogPlugin: CommandPlugin;

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

@@ -0,0 +1,22 @@
+import { DialogChoice } from '@/types/vuex';
+import { State } from 'vue';
+import { ActionContext } from 'vuex';
+import { ParserContext } from '../vm-parser';
+export declare type CommandRunner = (context: ActionContext<State, State>, 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 {
+    parserContext: ParserContext;
+    processCommandsFunction: ProcessCommandsFunction;
+    line: Parser.Line;
+    command: Partial<Parser.Command>;
+    lines: Parser.Line[];
+    currentLine: number;
+}
+export declare class CommandPlugin {
+    keyword: string;
+    runner: CommandRunner;
+    parser: CommandParserFunction;
+    constructor(keyword: string, runner: CommandRunner, parser: CommandParserFunction);
+}
+export declare function generateParser(keyword: string): (ctx: CommandParsingContext) => void;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const ifCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { VM } from '../vm';
+export declare function registerBaseCommands(vm: VM): void;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const jumpCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const notifyPlugin: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const pauseCommand: CommandPlugin;

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const play: CommandRunner;
+export declare const playCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const setCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const setButtonCommand: CommandPlugin;

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const setScreen: CommandRunner;
+export declare const setScreenCommand: CommandPlugin;

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

@@ -0,0 +1,3 @@
+import { CommandPlugin, CommandRunner } from './command-plugin';
+export declare const setStat: CommandRunner;
+export declare const setStatCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const stopCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const talkCommand: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const textCommandPlugin: CommandPlugin;

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

@@ -0,0 +1,2 @@
+import { CommandPlugin } from './command-plugin';
+export declare const waitCommand: CommandPlugin;

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

@@ -0,0 +1,17 @@
+import { AddDialogParams } from '@/store';
+import { State } from 'vue';
+import { ActionContext, Commit } from 'vuex';
+export declare function processSkillCheck(ctx: ActionContext<State, State>, skillcheck: Parser.SkillCheckOptions): boolean;
+export interface SkillCheckParams {
+    skill: string;
+    value: number;
+    id: string;
+    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 getLine(lines: Parser.Line[], index: number): Parser.Line;

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

@@ -0,0 +1,9 @@
+import { ProcessCommandsFunction } from './commands/command-plugin';
+export declare type ParserErrorHandler = (ctx: ParserContext, line: number, text: string) => void;
+export interface ParserContext {
+    fileName: string;
+    error: (line: number, text: string) => void;
+    processCommandsFunction: ProcessCommandsFunction;
+    indentSize: number;
+}
+export declare function parseScript(errorHandler: ParserErrorHandler, code: string, fileName: string): Parser.ParsedScript;

package/lib/vm/vm.d.ts

@@ -0,0 +1,20 @@
+import { ActionContext } from 'vuex';
+import { State } from 'vue';
+import { DialogChoice } from '@/types/vuex';
+import { CommandPlugin } from './commands/command-plugin';
+import { NarratPluginObject } from '@/plugins';
+export declare function runLine(context: ActionContext<State, State>): Promise<void>;
+export declare class VM {
+    plugins: NarratPluginObject[];
+    commands: {
+        [key: string]: CommandPlugin;
+    };
+    addCommand(command: CommandPlugin): void;
+    addPlugin(plugin: NarratPluginObject): void;
+    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;

package/package.json

@@ -1,85 +1,85 @@
-{
-  "name": "narrat",
-  "version": "0.10.0",
-  "description": "narrat narrative engine",
-  "main": "lib/index.js",
-  "module": "lib/index.esm.js",
-  "files": [
-    "lib/"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "snowpack dev",
-    "version": "npm run build",
-    "build": "cross-env NODE_ENV=production rollup -c",
-    "build-demo": "snowpack build",
-    "lint": "eslint src --ext=.js,.jsx,.ts,.tsx",
-    "preversion": "npm run build && npm run lint",
-    "postversion": "git push && git push --tags"
-  },
-  "keywords": [
-    "game"
-  ],
-  "author": "Liana Pigeot <liana.pigeot@protonmail.com>",
-  "license": "MIT",
-  "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@rollup/plugin-commonjs": "^16.0.0",
-    "@rollup/plugin-node-resolve": "^10.0.0",
-    "@rollup/plugin-typescript": "^8.2.5",
-    "@snowpack/plugin-postcss": "^1.4.3",
-    "@snowpack/plugin-sass": "^1.4.0",
-    "@snowpack/plugin-typescript": "^1.2.1",
-    "@snowpack/plugin-vue": "^2.6.2",
-    "@types/howler": "^2.2.3",
-    "@typescript-eslint/eslint-plugin": "^4.28.3",
-    "@typescript-eslint/parser": "^4.28.3",
-    "@vue/compiler-sfc": "^3.0.4",
-    "babel-loader": "^8.2.2",
-    "babel-plugin-syntax-dynamic-import": "^6.18.0",
-    "babel-preset-vue": "^2.0.2",
-    "cross-env": "^7.0.3",
-    "css-loader": "^5.0.1",
-    "es6-promise": "^4.2.8",
-    "eslint": "^7.30.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-import-resolver-typescript": "^2.4.0",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-vue": "^7.13.0",
-    "postcss": "^8.2.1",
-    "postcss-cli": "^8.3.1",
-    "prettier": "2.3.2",
-    "rollup": "^2.35.1",
-    "rollup-plugin-analyzer": "^4.0.0",
-    "rollup-plugin-inject-process-env": "^1.3.1",
-    "rollup-plugin-paths": "^0.0.4",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-postcss": "^4.0.0",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "rollup-plugin-version-injector": "^1.3.0",
-    "rollup-plugin-vue": "^6.0.0-beta.11",
-    "snowpack": "^3.8.6",
-    "tailwindcss": "^2.0.2",
-    "typescript": "^4.2.3",
-    "vue": "^3.2.2",
-    "vuex": "^4.0.0-rc.2"
-  },
-  "peerDependencies": {
-    "es6-promise": "^4.2.8",
-    "vue": "^3.0.4",
-    "vuex": "^4.0.0-rc.2"
-  },
-  "dependencies": {
-    "autoprefixer": "^10.2.6",
-    "deepmerge": "^4.2.2",
-    "fuse.js": "^6.6.2",
-    "howler": "^2.2.3",
-    "svelte-jsoneditor": "^0.3.58",
-    "vue3-mq": "^3.0.0"
-  }
-}
+{
+  "name": "narrat",
+  "version": "0.11.2",
+  "description": "narrat narrative engine",
+  "main": "lib/index.js",
+  "module": "lib/index.esm.js",
+  "files": [
+    "lib/"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "snowpack dev",
+    "version": "npm run build",
+    "build": "cross-env NODE_ENV=production rollup -c",
+    "build-demo": "snowpack build",
+    "lint": "eslint src --ext=.js,.jsx,.ts,.tsx",
+    "preversion": "npm run build && npm run lint",
+    "postversion": "git push && git push --tags"
+  },
+  "keywords": [
+    "game"
+  ],
+  "author": "Liana Pigeot <liana.pigeot@protonmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11",
+    "@rollup/plugin-commonjs": "^16.0.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
+    "@rollup/plugin-typescript": "^8.2.5",
+    "@snowpack/plugin-postcss": "^1.4.3",
+    "@snowpack/plugin-sass": "^1.4.0",
+    "@snowpack/plugin-typescript": "^1.2.1",
+    "@snowpack/plugin-vue": "^2.6.2",
+    "@types/howler": "^2.2.3",
+    "@typescript-eslint/eslint-plugin": "^4.28.3",
+    "@typescript-eslint/parser": "^4.28.3",
+    "@vue/compiler-sfc": "^3.0.4",
+    "babel-loader": "^8.2.2",
+    "babel-plugin-syntax-dynamic-import": "^6.18.0",
+    "babel-preset-vue": "^2.0.2",
+    "cross-env": "^7.0.3",
+    "css-loader": "^5.0.1",
+    "es6-promise": "^4.2.8",
+    "eslint": "^7.30.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-import-resolver-typescript": "^2.4.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-vue": "^7.13.0",
+    "postcss": "^8.2.1",
+    "postcss-cli": "^8.3.1",
+    "prettier": "2.3.2",
+    "rollup": "^2.35.1",
+    "rollup-plugin-analyzer": "^4.0.0",
+    "rollup-plugin-inject-process-env": "^1.3.1",
+    "rollup-plugin-paths": "^0.0.4",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-postcss": "^4.0.0",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "rollup-plugin-version-injector": "^1.3.0",
+    "rollup-plugin-vue": "^6.0.0-beta.11",
+    "snowpack": "^3.8.6",
+    "tailwindcss": "^2.0.2",
+    "typescript": "^4.2.3",
+    "vue": "^3.2.2",
+    "vuex": "^4.0.0-rc.2"
+  },
+  "peerDependencies": {
+    "es6-promise": "^4.2.8",
+    "vue": "^3.0.4",
+    "vuex": "^4.0.0-rc.2"
+  },
+  "dependencies": {
+    "autoprefixer": "^10.2.6",
+    "deepmerge": "^4.2.2",
+    "fuse.js": "^6.6.2",
+    "howler": "^2.2.3",
+    "svelte-jsoneditor": "^0.3.58",
+    "vue3-mq": "^3.0.0"
+  }
+}