🧪 Update tests and types for new toc

jupyter-book · May 22, 2024 · 6a1d956 · 6a1d956
1 parent 46d00cc
commit 6a1d956
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 4 deletions.
diff --git a/packages/myst-cli/src/project/fromTOC.ts b/packages/myst-cli/src/project/fromTOC.ts
@@ -87,6 +87,9 @@ export function projectFromTOC(
 ): Omit<LocalProject, 'bibliography'> {
   const pageSlugs: PageSlugs = {};
   const [root, ...entries] = toc;
+  if (!root) {
+    throw new Error('Project TOC must have at least one item');
+  }
   if (!isFile(root)) {
     throw new Error(`First TOC item should be a file`);
   }

diff --git a/packages/myst-cli/src/store/reducers.ts b/packages/myst-cli/src/store/reducers.ts
@@ -39,7 +39,7 @@ export const config = createSlice({
     currentProjectPath: string | undefined;
     currentSitePath: string | undefined;
     rawConfigs: Record<string, { raw: Record<string, any>; validated: ValidatedRawConfig }>;
-    projects: Record<string, ProjectConfig>;
+    projects: Record<string, Record<string, any>>;
     sites: Record<string, Record<string, any>>;
     filenames: Record<string, string>;
     configExtensions?: string[];

diff --git a/packages/myst-frontmatter/src/exports/exports.yml b/packages/myst-frontmatter/src/exports/exports.yml
@@ -427,6 +427,17 @@ cases:
           sub_articles:
             - a.md
     errors: 1
+  - title: export with invalid toc errors
+    raw:
+      exports:
+        - format: pdf
+          toc:
+            - foo.md
+    normalized:
+      exports:
+        - format: pdf
+          toc: []
+    errors: 1
   - title: zip passes
     raw:
       exports:

diff --git a/packages/myst-frontmatter/src/exports/types.ts b/packages/myst-frontmatter/src/exports/types.ts
@@ -1,3 +1,5 @@
+import type { TOC } from 'myst-toc';
+
 export enum ExportFormats {
   pdf = 'pdf',
   tex = 'tex',
@@ -22,7 +24,7 @@ export type Export = {
   template?: string | null;
   output?: string;
   zip?: boolean;
-  toc?: any[];
+  toc?: TOC;
   articles?: ExportArticle[];
   top_level?: 'parts' | 'chapters' | 'sections';
   /** sub_articles are only for jats xml export */

diff --git a/packages/myst-toc/src/toc.ts b/packages/myst-toc/src/toc.ts
@@ -213,5 +213,5 @@ export function validateEntry(entry: any, opts: ValidationOptions): Entry | unde
 export function validateTOC(toc: any, opts: ValidationOptions): TOC | undefined {
   return validateList(toc, opts, (item, ind) =>
     validateEntry(item, incrementOptions(`${ind}`, opts)),
-  ) as unknown as TOC | undefined;
+  );
 }
diff --git a/packages/myst-toc/tests/examples.spec.ts b/packages/myst-toc/tests/examples.spec.ts
@@ -119,3 +119,15 @@ test('Single parent entry without title', () => {
   ]);
   expect(opts.messages.warnings).toBeUndefined();
 });
+
+test('invalid toc entry', () => {
+  const input = ['invalid'];
+  validateTOC(input, opts);
+  expect(opts.messages.errors).toStrictEqual([
+    {
+      message: "'0' must be object (at test)",
+      property: '0',
+    },
+  ]);
+  expect(opts.messages.warnings).toBeUndefined();
+});
diff --git a/packages/mystmd/tests/multi-page-toc-tex/myst.yml b/packages/mystmd/tests/multi-page-toc-tex/myst.yml
@@ -16,4 +16,4 @@ project:
       template: ../template/tex
       output: _build/out-single.tex
       toc:
-        - one.md
+        - file: one.md