Release 2.2.5

ink.d.mts

@@ -1,41 +1,42 @@
-import { Story, InkList } from './engine/Story'
-import { Compiler } from './compiler/Compiler'
-import { CompilerOptions } from './compiler/CompilerOptions'
-import { PosixFileHandler } from './compiler/FileHandler/PosixFileHandler'
-import { JsonFileHandler } from './compiler/FileHandler/JsonFileHandler'
+import { Story, InkList } from "./engine/Story";
+import { Compiler } from "./compiler/Compiler";
+import { CompilerOptions } from "./compiler/CompilerOptions";
+import { PosixFileHandler } from "./compiler/FileHandler/PosixFileHandler";
+import { JsonFileHandler } from "./compiler/FileHandler/JsonFileHandler";
 
 declare interface Inkjs {
-    /**
-     * A Story is the core class that represents a complete Ink narrative, and
-     * manages runtime evaluation and state.
-     */
-    Story: typeof Story
- 
-    /**
-     * The underlying type for a list item in Ink.
-     */
-    InkList: typeof InkList
-
-    /**
-     * Compiles Ink stories from source.
-     */
-    Compiler: typeof Compiler
-
-    /**
-     * Metadata options for a compiler pass.
-     */
-    CompilerOptions: typeof CompilerOptions
-
-    /**
-     * Resolves and loads Ink sources from a POSIX filesystem.
-     */
-    PosixFileHandler: typeof PosixFileHandler
-
-    /**
-     * Resolves and loads Ink sources from a JSON hierarchy.
-     */
-    JsonFileHandler: typeof JsonFileHandler
+  /**
+   * A Story is the core class that represents a complete Ink narrative, and
+   * manages runtime evaluation and state.
+   */
+  Story: typeof Story;
+
+  /**
+   * The underlying type for a list item in Ink.
+   */
+  InkList: typeof InkList;
+
+  /**
+   * Compiles Ink stories from source.
+   */
+  Compiler: typeof Compiler;
+
+  /**
+   * Metadata options for a compiler pass.
+   */
+  CompilerOptions: typeof CompilerOptions;
+
+  /**
+   * Resolves and loads Ink sources from a POSIX filesystem.
+   */
+  PosixFileHandler: typeof PosixFileHandler;
+
+  /**
+   * Resolves and loads Ink sources from a JSON hierarchy.
+   */
+  JsonFileHandler: typeof JsonFileHandler;
 }
 
+
 declare let inkjs: Inkjs
-export default inkjs
+export = inkjs

package.json

@@ -1,11 +1,11 @@
 {
   "name": "inkjs",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "A javascript port of inkle's ink scripting language (http://www.inklestudios.com/ink/)",
   "type": "commonjs",
   "main": "dist/ink-full.js",
   "types": "ink.d.ts",
-  "files": ["src/engine","src/compiler","ink.d.ts", "ink.d.mts","script/inkjs-compiler.ts", "dist"],
+  "files": ["engine","compiler","ink.d.ts", "ink.d.mts","script/inkjs-compiler.ts", "dist"],
   "exports": {
     ".":{
       "types": "./ink.d.mts",
@@ -19,17 +19,16 @@
     }
   },
   "scripts": {
-    "test": "npm run test:typescript && npm run test:javascript",
+    "test": "npm run build && npm run test:typescript && npm run test:javascript",
     "test:typescript": "jest",
-    "test:javascript": "npm run test:javascript:dist && npm run test:javascript:legacy",
+    "test:javascript": "npm run build && npm run test:javascript:dist && npm run test:javascript:legacy",
     "test:javascript:dist": "INK_TEST=dist jest --config='jest.config.javascript.js'",
     "test:javascript:legacy": "INK_TEST=legacy jest --config='jest.config.javascript.js'",
     "test:compileFiles": "node src/tests/compile.js",
     "build": "tsc -p ./ && rollup -c",
     "lint": "eslint 'src/**/*.ts'",
     "lint:fix": "npm run lint -- --fix",
-    "watch": "tsc -p ./ && rollup -c -w",
-    "prepare": "npm run build"
+    "watch": "tsc -p ./ && rollup -c -w"
   },
   "author": "Yannick Lohse",
   "license": "MIT",

templates/typescript_player/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "ts-inkjs-player",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "tsc --resolveJsonModule -p . && tsx src/index.ts"
+  },
+  "keywords": [],
+  "author": "Sebastian Hanlon",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "tsx": "^4.15.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "inkjs": "*"
+  }
+}

templates/typescript_player/src/index.ts

@@ -0,0 +1,8 @@
+import { Story } from 'inkjs';
+import intercept from "./story.json";
+
+const s = new Story(intercept)
+
+let text = s.Continue()
+
+console.log(text)

templates/typescript_player/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2022"],
+    "skipLibCheck": true,
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "types": ["node"],
+    "outDir": "dist",
+    "declaration": true,
+    "resolveJsonModule": true,
+
+    /* Linting */
+    "strict": true
+  },
+  "include": ["src"]
+}

templates/typescript_with_compiler/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "ts-inkjs-with-compiler",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "tsc --resolveJsonModule -p . && tsx src/index.ts"
+  },
+  "keywords": [],
+  "author": "Sebastian Hanlon",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "tsx": "^4.15.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "inkjs": "*"
+  }
+}

templates/typescript_with_compiler/src/index.ts

@@ -0,0 +1,17 @@
+import { Compiler } from 'inkjs/full';
+
+const inkStory = `
+Once upon a time...
+
+ * There were two choices.
+ * There were four lines of content.
+
+- They lived happily ever after.
+    -> END
+`
+
+const s = new Compiler(inkStory).Compile()
+
+let text = s.Continue()
+
+console.log(text)

templates/typescript_with_compiler/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2022"],
+    "skipLibCheck": true,
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "types": ["node"],
+    "outDir": "dist",
+    "declaration": true,
+    "resolveJsonModule": true,
+
+    /* Linting */
+    "strict": true
+  },
+  "include": ["src"]
+}