Merge branch 'upgrade/ts-5.0' into typescript-upgrade

Author: smwhr

.github/workflows/checks.yml

@@ -8,11 +8,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm install
       - name: Install codecov

.github/workflows/npm-manual-publish.yml

@@ -9,10 +9,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm install
       - run: npm run lint
       - run: npm run build
@@ -23,11 +23,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: "16.x"
+          node-version: "20.x"
           registry-url: "https://registry.npmjs.org"
       - name: Install dependencies
         run: npm install

.github/workflows/npm-publish.yml

@@ -11,10 +11,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm install
       - run: npm run lint
       - run: npm run build
@@ -25,11 +25,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: "16.x"
+          node-version: "20.x"
           registry-url: "https://registry.npmjs.org"
       - name: Install dependencies
         run: npm install

README.md

@@ -140,7 +140,8 @@ var result = EvaluateFunction('my_ink_function', ['arg1', 'arg2'], true);
 As this library is a port from C#, it requires a less standard way to assign the `Story` class, including all other classes, to a variable:
 
 ```ts
-import { Story, Compiler } from 'inkjs';
+import { Story } from 'inkjs';
+import { Compiler } from 'inkjs/full'; // Compiler is not provided in the default inkjs package
 
 let story: InstanceType<typeof Story>;
 let compiler: InstanceType<typeof Compiler>;
@@ -149,7 +150,7 @@ let compiler: InstanceType<typeof Compiler>;
 Further, to minimize the verbose assignment, you can also create aliases in your project:
 
 ```ts
-import { Story, Compiler } from 'inkjs';
+import { Story, Compiler } from 'inkjs/full'; // Story is also provided in the "full" subpackage.
 
 export type InkStory = InstanceType<typeof Story>;
 export type InkCompiler= InstanceType<typeof Compiler>;

ink.d.mts

@@ -0,0 +1,41 @@
+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
+}
+
+declare let inkjs: Inkjs
+export default inkjs

ink.d.ts

@@ -1,15 +1,39 @@
-import { Story, InkList } from './src/engine/Story'
-import { Compiler } from './src/compiler/Compiler'
-import { CompilerOptions } from './src/compiler/CompilerOptions'
-import { PosixFileHandler } from './src/compiler/FileHandler/PosixFileHandler'
-import { JsonFileHandler } from './src/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
 }