feat(Config): make Config.tools fields optional

live-codes · Apr 16, 2024 · 42342a7 · 42342a7
1 parent cf0e3bb
commit 42342a7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/docs/docs/configuration/configuration-object.md b/docs/docs/configuration/configuration-object.md
@@ -382,7 +382,7 @@ Sets [display mode](../features/display-modes.md)
 
 ### `tools`
 
-Type: [`{ enabled: Array<'console' | 'compiled' | 'tests'> | 'all'; active: 'console' | 'compiled' | 'tests' | ''; status: 'closed' | 'open' | 'full' | 'none' | ''; }`](../api/interfaces/Config.md#tools)
+Type: [`Partial<{ enabled: Array<'console' | 'compiled' | 'tests'> | 'all'; active: 'console' | 'compiled' | 'tests' | ''; status: 'closed' | 'open' | 'full' | 'none' | ''; }>`](../api/interfaces/Config.md#tools)
 
 Default: `{ enabled: 'all', active: '', status: '' }`
 

diff --git a/src/livecodes/config/build-config.ts b/src/livecodes/config/build-config.ts
@@ -261,7 +261,11 @@ export const loadParamConfig = (config: Config, params: UrlQueryParams): Partial
       }
 
       if (!status && ['open', 'full', 'closed'].includes(params[tool]!)) {
-        if (paramsConfig.tools.enabled !== 'all' && !paramsConfig.tools.enabled.includes(tool)) {
+        if (
+          paramsConfig.tools.enabled &&
+          paramsConfig.tools.enabled !== 'all' &&
+          !paramsConfig.tools.enabled.includes(tool)
+        ) {
           paramsConfig.tools.enabled.push(tool);
         }
         paramsConfig.tools.active = tool;
@@ -273,9 +277,9 @@ export const loadParamConfig = (config: Config, params: UrlQueryParams): Partial
         if (paramsConfig.tools.enabled === 'all') {
           paramsConfig.tools.enabled = [...allTools];
         }
-        paramsConfig.tools.enabled = paramsConfig.tools.enabled.filter((t) => t !== tool);
+        paramsConfig.tools.enabled = paramsConfig.tools.enabled?.filter((t) => t !== tool) || [];
         if (paramsConfig.tools.active === tool) {
-          paramsConfig.tools.active = paramsConfig.tools.enabled[0];
+          paramsConfig.tools.active = paramsConfig.tools.enabled?.[0] || '';
         }
       }
     });

diff --git a/src/livecodes/config/validate-config.ts b/src/livecodes/config/validate-config.ts
@@ -65,7 +65,7 @@ export const validateConfig = (config: Partial<Config>): Partial<Config> => {
     ...(x && is(x.position, 'object') ? { position: x.position } : {}),
   });
 
-  const validateToolsProps = (x: Partial<Config['tools']>): Config['tools'] => ({
+  const validateToolsProps = (x: Config['tools']): Config['tools'] => ({
     ...defaultConfig.tools,
     ...(x && Array.isArray(x.enabled)
       ? { enabled: x.enabled.filter((t) => tools.includes(t)) }

diff --git a/src/livecodes/toolspane/tools.ts b/src/livecodes/toolspane/tools.ts
@@ -42,7 +42,7 @@ export const createToolsPane = (
   ];
 
   const isEnabled = (tool: ToolList[number]) =>
-    config.tools.enabled === 'all' || config.tools.enabled.includes(tool.name);
+    config.tools.enabled === 'all' || config.tools.enabled?.includes(tool.name) === true;
 
   const toolList: ToolList = fullList.filter(isEnabled);
 
@@ -344,7 +344,7 @@ export const createToolsPane = (
 
   const load = async () => {
     const initialLoad = status === undefined;
-    activeToolId = getToolId(config.tools.active);
+    activeToolId = getToolId(config.tools.active || '');
     status = config.tools.status || 'closed';
 
     if (initialLoad) {

diff --git a/src/sdk/models.ts b/src/sdk/models.ts
@@ -94,11 +94,11 @@ export interface AppConfig {
   readonly: boolean;
   allowLangChange: boolean;
   mode: 'full' | 'focus' | 'simple' | 'editor' | 'codeblock' | 'result';
-  tools: {
+  tools: Partial<{
     enabled: Array<Tool['name']> | 'all';
     active: Tool['name'] | '';
     status: ToolsPaneStatus;
-  };
+  }>;
   zoom: 1 | 0.5 | 0.25;
 }