🆙 Update mystjs and add more definitive return type (#57)

package.json

@@ -61,7 +61,7 @@
     "katex": "^0.15.2",
     "lodash.throttle": "^4.1.1",
     "mime-types": "^2.1.35",
-    "mystjs": "^0.0.5",
+    "mystjs": "^0.0.6",
     "nanoid": "^3.3.2",
     "node-fetch": "^2.6.7",
     "p-limit": "^3.1.0",

src/web/transforms/keys.ts

@@ -1,6 +1,6 @@
 import { createId } from '@curvenote/schema';
 import { GenericNode, map } from 'mystjs';
-import { Root } from './types';
+import { MapResult, Root } from './types';
 
 function addKeys(node: GenericNode) {
   node.key = createId();
@@ -13,6 +13,6 @@ function addKeys(node: GenericNode) {
  * @param mdast
  * @returns
  */
-export function transformKeys<T extends GenericNode | Root>(mdast: T) {
+export function transformKeys<T extends GenericNode | Root>(mdast: T): MapResult {
   return map(mdast, addKeys);
 }

src/web/transforms/root.ts

@@ -1,7 +1,7 @@
 import { State, transform, unified } from 'mystjs';
 import { Root } from './types';
 
-export async function transformRoot(mdast: Root) {
+export async function transformRoot(mdast: Root): Promise<Root> {
   const state = new State();
   mdast = await unified()
     .use(transform, state, { addContainerCaptionNumbers: true })

src/web/transforms/types.ts

@@ -1,9 +1,10 @@
+import { GenericNode, MyST, map } from 'mystjs';
 import { CitationRenderer } from 'citation-js-utils';
-import { GenericNode, MyST } from 'mystjs';
 import { Frontmatter } from '../frontmatter';
 import { IDocumentCache } from '../types';
 
 export type Root = ReturnType<typeof MyST.prototype.parse>;
+export type MapResult = ReturnType<typeof map>;
 
 export type Citations = {
   order: string[];

src/web/utils.ts

@@ -22,7 +22,7 @@ export function ensureBuildFolderExists(opts: Options) {
   if (!exists(opts)) fs.mkdirSync(serverPath(opts), { recursive: true });
 }
 
-export function parseMyst(content: string) {
+export function parseMyst(content: string): Root {
   const myst = new MyST({
     roles: { ...reactiveRoles },
     directives: { ...directives },

tsconfig.json

@@ -6,19 +6,28 @@
     "target": "es6",
     "noImplicitAny": true,
     "strict": true,
+    "preserveSymlinks": true,
     "moduleResolution": "node",
-    "lib": ["es2019"],
+    "lib": [
+      "es2019"
+    ],
     "sourceMap": true,
     // outDir is overridden from the build:esm/build:cjs scripts
     "outDir": "dist",
     "baseUrl": ".",
     // Type roots allows it to be included in a yarn workspace
-    "typeRoots": ["./types", "./node_modules/@types", "../../node_modules/@types"],
+    "typeRoots": [
+      "./types",
+      "./node_modules/@types",
+      "../../node_modules/@types"
+    ],
     "resolveJsonModule": true,
     "declaration": true,
     // Ignore node_modules, etc.
     "skipLibCheck": true
   },
-  "include": ["src/**/*"],
+  "include": [
+    "src/**/*"
+  ],
   "exclude": []
 }