From a236229d72792246b82c20c59f8e7a7f7177ee86 Mon Sep 17 00:00:00 2001 From: PINGUET Julien Date: Mon, 11 Nov 2024 21:17:34 +0100 Subject: [PATCH 1/2] feat(typing): add declaration type --- packages/mock-addon/package.json | 2 +- packages/mock-addon/src/typings.d.ts | 1 - packages/mock-addon/typings.d.ts | 42 ++++++++++++++++++++++++++++ 3 files changed, 43 insertions(+), 2 deletions(-) delete mode 100644 packages/mock-addon/src/typings.d.ts create mode 100644 packages/mock-addon/typings.d.ts diff --git a/packages/mock-addon/package.json b/packages/mock-addon/package.json index dde1e11..8feef9f 100644 --- a/packages/mock-addon/package.json +++ b/packages/mock-addon/package.json @@ -22,7 +22,7 @@ }, "main": "dist/cjs/index.js", "module": "dist/esm/index.js", - "types": "dist/ts/index.d.ts", + "types": "typings.d.ts", "files": [ "dist/**/*", "README.md", diff --git a/packages/mock-addon/src/typings.d.ts b/packages/mock-addon/src/typings.d.ts deleted file mode 100644 index 0f79d45..0000000 --- a/packages/mock-addon/src/typings.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare module "global"; \ No newline at end of file diff --git a/packages/mock-addon/typings.d.ts b/packages/mock-addon/typings.d.ts new file mode 100644 index 0000000..b239a66 --- /dev/null +++ b/packages/mock-addon/typings.d.ts @@ -0,0 +1,42 @@ +type JSONValue = string | number | boolean | JSONObject | JSONArray +type JSONArray = Array +interface JSONObject { + [x: string]: JSONValue +} + +export type Method = 'GET' | 'PUT' | 'POST' | 'DELETE' | 'PATCH' | 'OPTIONS' + +export type Request = { + body: string | null + method: Method + signal: AbortSignal | null + url: string + searchParams?: string +} + +export type ResponseObj = JSONObject | JSONArray +export type ResponseFn = (request: Request) => JSONValue +export type Response = ResponseObj | ResponseFn + +export type StorybookAddonMockData = { + url: string + /** @default GET */ + method: Method + /** @default 0 */ + delay?: number + status: number + response: Response +} + +declare module '@storybook/csf' { + interface Parameters { + mockAddonConfigs?: { + globalMockData?: StorybookAddonMockData[] + ignoreQueryParams?: boolean + refreshStoryOnUpdate?: boolean + disableUsingOriginal?: boolean + disable?: boolean + } + mockData?: StorybookAddonMockData[] + } +} From 36caa3aa52c46f6051780fe34cbfd82818bf4cec Mon Sep 17 00:00:00 2001 From: PINGUET Julien Date: Wed, 9 Jul 2025 15:49:47 +0200 Subject: [PATCH 2/2] fix: remove bad default value in comments --- packages/mock-addon/typings.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/mock-addon/typings.d.ts b/packages/mock-addon/typings.d.ts index b239a66..0659a13 100644 --- a/packages/mock-addon/typings.d.ts +++ b/packages/mock-addon/typings.d.ts @@ -20,7 +20,6 @@ export type Response = ResponseObj | ResponseFn export type StorybookAddonMockData = { url: string - /** @default GET */ method: Method /** @default 0 */ delay?: number