@kubb/plugin-msw 0.0.0-canary-20241104172400

package/dist/components.d.ts

@@ -0,0 +1,37 @@
+import { HttpMethod } from '@kubb/oas';
+import { ReactNode } from 'react';
+
+type Props$1 = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    fakerName: string;
+    url: string;
+    method: HttpMethod;
+};
+declare function Mock({ name, fakerName, typeName, url, method }: Props$1): ReactNode;
+
+type HandlersProps = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    handlers: string[];
+};
+declare function Handlers({ name, handlers }: HandlersProps): ReactNode;
+
+type Props = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    fakerName: string;
+    url: string;
+    method: HttpMethod;
+};
+declare function MockWithFaker({ name, fakerName, typeName, url, method }: Props): ReactNode;
+
+export { Handlers, Mock, MockWithFaker };

package/dist/components.js

@@ -0,0 +1,3 @@
+export { Handlers, Mock, MockWithFaker } from './chunk-YG3WMS3Q.js';
+//# sourceMappingURL=components.js.map
+//# sourceMappingURL=components.js.map

package/dist/components.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"components.js"}

package/dist/generators.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var chunkQXK7PR6Z_cjs = require('./chunk-QXK7PR6Z.cjs');
+require('./chunk-XLGN5MEF.cjs');
+
+
+
+Object.defineProperty(exports, "handlersGenerator", {
+  enumerable: true,
+  get: function () { return chunkQXK7PR6Z_cjs.handlersGenerator; }
+});
+Object.defineProperty(exports, "mswGenerator", {
+  enumerable: true,
+  get: function () { return chunkQXK7PR6Z_cjs.mswGenerator; }
+});
+//# sourceMappingURL=generators.cjs.map
+//# sourceMappingURL=generators.cjs.map

package/dist/generators.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"generators.cjs"}

package/dist/generators.d.cts

@@ -0,0 +1,9 @@
+import * as _kubb_plugin_oas from '@kubb/plugin-oas';
+import { P as PluginMsw } from './types-BaK4s79H.cjs';
+import '@kubb/core';
+
+declare const mswGenerator: _kubb_plugin_oas.Generator<PluginMsw>;
+
+declare const handlersGenerator: _kubb_plugin_oas.Generator<PluginMsw>;
+
+export { handlersGenerator, mswGenerator };

package/dist/generators.d.ts

@@ -0,0 +1,9 @@
+import * as _kubb_plugin_oas from '@kubb/plugin-oas';
+import { P as PluginMsw } from './types-BaK4s79H.js';
+import '@kubb/core';
+
+declare const mswGenerator: _kubb_plugin_oas.Generator<PluginMsw>;
+
+declare const handlersGenerator: _kubb_plugin_oas.Generator<PluginMsw>;
+
+export { handlersGenerator, mswGenerator };

package/dist/generators.js

@@ -0,0 +1,4 @@
+export { handlersGenerator, mswGenerator } from './chunk-IUWTMC3G.js';
+import './chunk-YG3WMS3Q.js';
+//# sourceMappingURL=generators.js.map
+//# sourceMappingURL=generators.js.map

package/dist/generators.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"generators.js"}

package/dist/index.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var chunkQXK7PR6Z_cjs = require('./chunk-QXK7PR6Z.cjs');
+require('./chunk-XLGN5MEF.cjs');
+
+
+
+Object.defineProperty(exports, "pluginMsw", {
+  enumerable: true,
+  get: function () { return chunkQXK7PR6Z_cjs.pluginMsw; }
+});
+Object.defineProperty(exports, "pluginMswName", {
+  enumerable: true,
+  get: function () { return chunkQXK7PR6Z_cjs.pluginMswName; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginMsw } from './types-BaK4s79H.cjs';
+import '@kubb/plugin-oas';
+
+declare const pluginMswName = "plugin-msw";
+declare const pluginMsw: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginMsw>;
+
+export { PluginMsw, pluginMsw, pluginMswName };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginMsw } from './types-BaK4s79H.js';
+import '@kubb/plugin-oas';
+
+declare const pluginMswName = "plugin-msw";
+declare const pluginMsw: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginMsw>;
+
+export { PluginMsw, pluginMsw, pluginMswName };

package/dist/index.js

@@ -0,0 +1,4 @@
+export { pluginMsw, pluginMswName } from './chunk-IUWTMC3G.js';
+import './chunk-YG3WMS3Q.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/types-BaK4s79H.d.cts

@@ -0,0 +1,55 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'mocks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the MSW mocks based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Create `handlers.ts` file with all handlers grouped by methods.
+     * @default false
+     */
+    handlers?: boolean;
+    /**
+     * Which parser should be used before returning the data to the `Response` of MSW.
+     *  - `'faker'` will use `@kubb/plugin-faker` to generate the data for the response
+     *  - `'data'` will use your custom data to generate the data for the response
+     * @default 'data'
+     */
+    parser?: 'data' | 'faker';
+    /**
+     * Define some generators next to the msw generators
+     */
+    generators?: Array<Generator<PluginMsw>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    parser: NonNullable<Options['parser']>;
+};
+type PluginMsw = PluginFactoryOptions<'plugin-msw', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginMsw as P };

package/dist/types-BaK4s79H.d.ts

@@ -0,0 +1,55 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'mocks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the MSW mocks based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Create `handlers.ts` file with all handlers grouped by methods.
+     * @default false
+     */
+    handlers?: boolean;
+    /**
+     * Which parser should be used before returning the data to the `Response` of MSW.
+     *  - `'faker'` will use `@kubb/plugin-faker` to generate the data for the response
+     *  - `'data'` will use your custom data to generate the data for the response
+     * @default 'data'
+     */
+    parser?: 'data' | 'faker';
+    /**
+     * Define some generators next to the msw generators
+     */
+    generators?: Array<Generator<PluginMsw>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    parser: NonNullable<Options['parser']>;
+};
+type PluginMsw = PluginFactoryOptions<'plugin-msw', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginMsw as P };

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "@kubb/plugin-msw",
+  "version": "0.0.0-canary-20241104172400",
+  "description": "Generator swagger",
+  "keywords": [
+    "typescript",
+    "plugins",
+    "kubb",
+    "codegen",
+    "swagger",
+    "openapi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-msw"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./utils": {
+      "import": "./dist/utils.js",
+      "require": "./dist/utils.cjs",
+      "default": "./dist/utils.cjs"
+    },
+    "./hooks": {
+      "import": "./dist/hooks.js",
+      "require": "./dist/hooks.cjs",
+      "default": "./dist/hooks.cjs"
+    },
+    "./components": {
+      "import": "./dist/components.js",
+      "require": "./dist/components.cjs",
+      "default": "./dist/components.cjs"
+    },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "utils": [
+        "./dist/utils.d.ts"
+      ],
+      "hooks": [
+        "./dist/hooks.d.ts"
+      ],
+      "components": [
+        "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "@kubb/core": "0.0.0-canary-20241104172400",
+    "@kubb/fs": "0.0.0-canary-20241104172400",
+    "@kubb/oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-faker": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-ts": "0.0.0-canary-20241104172400",
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.12",
+    "react": "^18.3.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@kubb/config-ts": "0.0.0-canary-20241104172400",
+    "@kubb/config-tsup": "0.0.0-canary-20241104172400"
+  },
+  "peerDependencies": {
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "npx rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}

package/src/components/Handlers.tsx

@@ -0,0 +1,19 @@
+import { File } from '@kubb/react'
+import type { ReactNode } from 'react'
+
+type HandlersProps = {
+  /**
+   * Name of the function
+   */
+  name: string
+  // custom
+  handlers: string[]
+}
+
+export function Handlers({ name, handlers }: HandlersProps): ReactNode {
+  return (
+    <File.Source name={name} isIndexable isExportable>
+      {`export const ${name} = ${JSON.stringify(handlers).replaceAll(`"`, '')} as const`}
+    </File.Source>
+  )
+}

package/src/components/Mock.tsx

@@ -0,0 +1,38 @@
+import { File, Function, FunctionParams } from '@kubb/react'
+
+import type { HttpMethod } from '@kubb/oas'
+import type { ReactNode } from 'react'
+
+type Props = {
+  /**
+   * Name of the function
+   */
+  name: string
+  typeName: string
+  fakerName: string
+  url: string
+  method: HttpMethod
+}
+
+export function Mock({ name, fakerName, typeName, url, method }: Props): ReactNode {
+  const params = FunctionParams.factory({
+    data: {
+      type: typeName,
+      optional: true,
+    },
+  })
+
+  return (
+    <File.Source name={name} isIndexable isExportable>
+      <Function name={name} export params={params.toConstructor()}>
+        {`return http.${method}('*${url}', function handler(info) {
+    return new Response(JSON.stringify(data), {
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    })
+  })`}
+      </Function>
+    </File.Source>
+  )
+}

package/src/components/MockWithFaker.tsx

@@ -0,0 +1,38 @@
+import { File, Function, FunctionParams } from '@kubb/react'
+
+import type { HttpMethod } from '@kubb/oas'
+import type { ReactNode } from 'react'
+
+type Props = {
+  /**
+   * Name of the function
+   */
+  name: string
+  typeName: string
+  fakerName: string
+  url: string
+  method: HttpMethod
+}
+
+export function MockWithFaker({ name, fakerName, typeName, url, method }: Props): ReactNode {
+  const params = FunctionParams.factory({
+    data: {
+      type: typeName,
+      optional: true,
+    },
+  })
+
+  return (
+    <File.Source name={name} isIndexable isExportable>
+      <Function name={name} export params={params.toConstructor()}>
+        {`return http.${method}('*${url}', function handler(info) {
+    return new Response(JSON.stringify(${fakerName}(data)), {
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    })
+  })`}
+      </Function>
+    </File.Source>
+  )
+}

package/src/components/index.ts

@@ -0,0 +1,3 @@
+export { Mock } from './Mock.tsx'
+export { Handlers } from './Handlers.tsx'
+export { MockWithFaker } from './MockWithFaker.tsx'

package/src/generators/__snapshots__/createPet.ts

@@ -0,0 +1,11 @@
+import { http } from "msw";
+
+ export function createPets(data?: CreatePetsMutationResponse) {
+    return http.post("*/pets", function handler(info) {
+        return new Response(JSON.stringify(data), {
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    });
+}

package/src/generators/__snapshots__/deletePet.ts

@@ -0,0 +1,11 @@
+import { http } from "msw";
+
+ export function deletePetsPetid(data?: DeletePetsPetidMutationResponse) {
+    return http.delete("*/pets/:petId", function handler(info) {
+        return new Response(JSON.stringify(data), {
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    });
+}

package/src/generators/__snapshots__/getPets.ts

@@ -0,0 +1,11 @@
+import { http } from "msw";
+
+ export function listPets(data?: ListPetsQueryResponse) {
+    return http.get("*/pets", function handler(info) {
+        return new Response(JSON.stringify(data), {
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    });
+}

package/src/generators/__snapshots__/getPetsFaker.ts

@@ -0,0 +1,11 @@
+import { http } from "msw";
+
+ export function listPets(data?: ListPetsQueryResponse) {
+    return http.get("*/pets", function handler(info) {
+        return new Response(JSON.stringify(listPetsQueryResponse(data)), {
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    });
+}

package/src/generators/__snapshots__/handlers.ts

@@ -0,0 +1,3 @@
+import { listPets, createPets, showPetById } from "./findByTags";
+
+ export const handlers = [listPets(), createPets(), showPetById()] as const;

package/src/generators/__snapshots__/showPetById.ts

@@ -0,0 +1,11 @@
+import { http } from "msw";
+
+ export function showPetById(data?: ShowPetByIdQueryResponse) {
+    return http.get("*/pets/:petId", function handler(info) {
+        return new Response(JSON.stringify(data), {
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    });
+}

package/src/generators/handlersGenerator.tsx

@@ -0,0 +1,32 @@
+import { createReactGenerator } from '@kubb/plugin-oas'
+import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { File, useApp } from '@kubb/react'
+import { Handlers } from '../components/Handlers.tsx'
+import { pluginMswName } from '../plugin.ts'
+import type { PluginMsw } from '../types'
+
+export const handlersGenerator = createReactGenerator<PluginMsw>({
+  name: 'plugin-msw',
+  Operations({ operations }) {
+    const { pluginManager, plugin } = useApp<PluginMsw>()
+    const { getName, getFile } = useOperationManager()
+
+    const file = pluginManager.getFile({ name: 'handlers', extname: '.ts', pluginKey: [pluginMswName] })
+
+    const imports = operations.map((operation) => {
+      const operationFile = getFile(operation, { pluginKey: [pluginMswName] })
+      const operationName = getName(operation, { pluginKey: [pluginMswName], type: 'function' })
+
+      return <File.Import key={operationFile.path} name={[operationName]} root={file.path} path={operationFile.path} />
+    })
+
+    const handlers = operations.map((operation) => `${getName(operation, { type: 'function', pluginKey: [pluginMswName] })}()`)
+
+    return (
+      <File baseName={file.baseName} path={file.path} meta={file.meta} banner={plugin.options.output?.banner} footer={plugin.options.output?.footer}>
+        {imports}
+        <Handlers name={'handlers'} handlers={handlers} />
+      </File>
+    )
+  },
+})

package/src/generators/index.ts

@@ -0,0 +1,2 @@
+export { mswGenerator } from './mswGenerator.tsx'
+export { handlersGenerator } from './handlersGenerator.tsx'

package/src/generators/mswGenerator.tsx

@@ -0,0 +1,64 @@
+import { URLPath } from '@kubb/core/utils'
+import { pluginFakerName } from '@kubb/plugin-faker'
+import { createReactGenerator } from '@kubb/plugin-oas'
+import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { pluginTsName } from '@kubb/plugin-ts'
+import { File, useApp } from '@kubb/react'
+import { Mock, MockWithFaker } from '../components'
+import type { PluginMsw } from '../types'
+
+export const mswGenerator = createReactGenerator<PluginMsw>({
+  name: 'msw',
+  Operation({ operation }) {
+    const {
+      plugin: {
+        options: { output, parser },
+      },
+    } = useApp<PluginMsw>()
+    const { getSchemas, getName, getFile } = useOperationManager()
+
+    const mock = {
+      name: getName(operation, { type: 'function' }),
+      file: getFile(operation),
+    }
+
+    const faker = {
+      file: getFile(operation, { pluginKey: [pluginFakerName] }),
+      schemas: getSchemas(operation, { pluginKey: [pluginFakerName], type: 'function' }),
+    }
+
+    const type = {
+      file: getFile(operation, { pluginKey: [pluginTsName] }),
+      schemas: getSchemas(operation, { pluginKey: [pluginTsName], type: 'type' }),
+    }
+
+    return (
+      <File baseName={mock.file.baseName} path={mock.file.path} meta={mock.file.meta} banner={output?.banner} footer={output?.footer}>
+        <File.Import name={['http']} path={'msw'} />
+        <File.Import name={[type.schemas.response.name]} path={type.file.path} root={mock.file.path} isTypeOnly />
+        {parser === 'faker' && faker.file && faker.schemas.response && (
+          <File.Import name={[faker.schemas.response.name]} root={mock.file.path} path={faker.file.path} />
+        )}
+
+        {parser === 'faker' && (
+          <MockWithFaker
+            name={mock.name}
+            typeName={type.schemas.response.name}
+            fakerName={faker.schemas.response.name}
+            method={operation.method}
+            url={new URLPath(operation.path).toURLPath()}
+          />
+        )}
+        {parser === 'data' && (
+          <Mock
+            name={mock.name}
+            typeName={type.schemas.response.name}
+            fakerName={faker.schemas.response.name}
+            method={operation.method}
+            url={new URLPath(operation.path).toURLPath()}
+          />
+        )}
+      </File>
+    )
+  },
+})

package/src/index.ts

@@ -0,0 +1,2 @@
+export { pluginMsw, pluginMswName } from './plugin.ts'
+export type { PluginMsw } from './types.ts'