Doc Tools: Signature Type Error Handling

code/lib/core-events/src/errors/server-errors.test.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect } from 'vitest';
-import { WebpackCompilationError } from './server-errors';
+import dedent from 'ts-dedent';
+import { UnknownArgTypesError, WebpackCompilationError } from './server-errors';
 
 describe('WebpackCompilationError', () => {
   it('should correctly handle error with stats.compilation.errors', () => {
@@ -14,3 +15,20 @@ describe('WebpackCompilationError', () => {
     expect(webpackError.data.errors[1].message).toEqual('Error 2 message');
   });
 });
+
+describe('UnknownFlowArgTypesError', () => {
+  it('should correctly handle error with Flow convertSig', () => {
+    const type = {
+      name: 'signature',
+      type: 'number',
+      signature: 1,
+    };
+
+    const message = dedent`We detected a type {"name":"signature","type":"number","signature":1} in your configuration.
+    Your custom type does not match the TSFuncSigType or TSObjectSigType
+    Please check your Storybook configuration and ensure you have defined a valid type.`;
+
+    const typeError = new UnknownArgTypesError({ type });
+    expect(typeError.message).toEqual(message);
+  });
+});

code/lib/core-events/src/errors/server-errors.ts

@@ -604,3 +604,20 @@ export class NoStatsForViteDevError extends StorybookError {
     `;
   }
 }
+
+export class UnknownArgTypesError extends StorybookError {
+  readonly category = Category.DOCS_TOOLS;
+
+  readonly code = 1;
+
+  constructor(public data: { type: object }) {
+    super();
+  }
+
+  template() {
+    return dedent`We detected a type ${JSON.stringify(this.data.type)} in your configuration.
+    Your custom type does not match the TSFuncSigType or TSObjectSigType
+    Please check your Storybook configuration and ensure you have defined a valid type.
+    `;
+  }
+}

code/lib/docs-tools/src/argTypes/convert/flow/convert.ts

@@ -1,3 +1,4 @@
+import { UnknownArgTypesError } from '@storybook/core-events/server-errors';
 import type { SBType } from '@storybook/types';
 import type { FlowType, FlowSigType, FlowLiteralType } from './types';
 
@@ -18,7 +19,7 @@ const convertSig = (type: FlowSigType) => {
         value: values,
       };
     default:
-      throw new Error(`Unknown: ${type}`);
+      throw new UnknownArgTypesError({ type: type });
   }
 };
 

code/lib/docs-tools/src/argTypes/convert/typescript/convert.ts

@@ -1,3 +1,4 @@
+import { UnknownArgTypesError } from '@storybook/core-events/server-errors';
 import type { SBType } from '@storybook/types';
 import type { TSType, TSSigType } from './types';
 import { parseLiteral } from '../utils';
@@ -16,7 +17,7 @@ const convertSig = (type: TSSigType) => {
         value: values,
       };
     default:
-      throw new Error(`Unknown: ${type}`);
+      throw new UnknownArgTypesError({ type });
   }
 };