🐿 fix thebe types

.changeset/new-feet-mate.md

@@ -0,0 +1,5 @@
+---
+'myst-frontmatter': patch
+---
+
+Changes thebe types to correctly provide the shapes of expanded thebe options after frontmatter validation. Updated the validator to use the types.

packages/myst-frontmatter/src/project/types.ts

@@ -4,7 +4,7 @@ import type { Licenses } from '../licenses/types.js';
 import type { Numbering } from '../numbering/types.js';
 import type { ProjectSettings } from '../settings/types.js';
 import type { SiteFrontmatter } from '../site/types.js';
-import type { Thebe } from '../thebe/types.js';
+import type { ExpandedThebeFrontmatter } from '../thebe/types.js';
 
 export type ProjectAndPageFrontmatter = SiteFrontmatter & {
   date?: string;
@@ -34,5 +34,5 @@ export type ProjectFrontmatter = ProjectAndPageFrontmatter & {
   references?: Record<string, { url: string }>;
   requirements?: string[];
   resources?: string[];
-  thebe?: Thebe;
+  thebe?: ExpandedThebeFrontmatter;
 };

packages/myst-frontmatter/src/thebe/types.ts

@@ -1,4 +1,6 @@
-export type Thebe = {
+export type ThebeFrontmatter = boolean | string | ThebeFrontmatterObject;
+
+export type ThebeFrontmatterObject = {
   lite?: boolean;
   binder?: boolean | BinderHubOptions;
   server?: JupyterServerOptions;
@@ -9,6 +11,11 @@ export type Thebe = {
   mathjaxConfig?: string;
 };
 
+// NOTE: currently a subtle difference but will likely grow with lite options
+export type ExpandedThebeFrontmatter = Omit<ThebeFrontmatterObject, 'binder'> & {
+  binder?: BinderHubOptions;
+};
+
 export type WellKnownRepoProviders = 'github' | 'gitlab' | 'git' | 'gist';
 export type BinderProviders = WellKnownRepoProviders | string;
 

packages/myst-frontmatter/src/thebe/validators.ts

@@ -3,14 +3,19 @@ import {
   defined,
   incrementOptions,
   validateBoolean,
-  validateObject,
   validateObjectKeys,
   validateString,
   validateUrl,
   validationError,
 } from 'simple-validators';
 import { GITHUB_USERNAME_REPO_REGEX } from '../utils/validators.js';
-import type { BinderHubOptions, JupyterServerOptions, Thebe } from './types.js';
+import type {
+  BinderHubOptions,
+  JupyterServerOptions,
+  ExpandedThebeFrontmatter,
+  ThebeFrontmatter,
+  ThebeFrontmatterObject,
+} from './types.js';
 
 const THEBE_KEYS = [
   'lite',
@@ -32,10 +37,10 @@ const JUPYTER_SERVER_OPTIONS_KEYS = ['url', 'token'];
  * https://thebe-core.curve.space/docs-core/a-configuration
  */
 export function validateThebe(
-  input: any,
+  input: ThebeFrontmatter,
   github: string | undefined,
   opts: ValidationOptions,
-): Thebe | undefined {
+): ExpandedThebeFrontmatter | undefined {
   if (input === false) return undefined;
   if (input === 'lite') return { lite: true };
   if (typeof input === 'string' && input !== 'binder') {
@@ -45,16 +50,22 @@ export function validateThebe(
     );
   }
 
-  let inputObject: Record<string, any> = input;
+  let inputObject: ThebeFrontmatterObject;
   if (input === true || input === 'binder') {
     // expand boolean methods to object
     inputObject = { binder: true };
+  } else {
+    inputObject = input;
   }
 
-  const value: Thebe | undefined = validateObjectKeys(inputObject, { optional: THEBE_KEYS }, opts);
+  const value: ThebeFrontmatter | undefined = validateObjectKeys(
+    inputObject,
+    { optional: THEBE_KEYS },
+    opts,
+  );
 
   if (value === undefined) return undefined;
-  const output: Thebe = {};
+  const output: ExpandedThebeFrontmatter = {};
   if (defined(value.lite)) {
     output.lite = validateBoolean(value.lite, incrementOptions('lite', opts));
   }