@devup-api/rsbuild-plugin 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@devup-api/rsbuild-plugin",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "license": "Apache-2.0",
   "type": "module",
   "exports": {
     ".": {
@@ -9,6 +10,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc && bun build --target node --outfile=dist/index.js src/index.ts --production --packages=external && bun build --target node --outfile=dist/index.cjs --format=cjs src/index.ts --production --packages=external"
   },
@@ -16,9 +20,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@devup-api/utils": "0.1.0",
-    "@devup-api/core": "0.1.0",
-    "@devup-api/generator": "0.1.0"
+    "@devup-api/utils": "0.1.1",
+    "@devup-api/core": "0.1.1",
+    "@devup-api/generator": "0.1.1"
   },
   "peerDependencies": {
     "@rsbuild/core": "*",

package/src/__tests__/index.test.ts

@@ -1,9 +0,0 @@
-import { expect, test } from 'bun:test'
-import * as indexModule from '../index'
-
-test('index.ts exports', () => {
-  expect({ ...indexModule }).toEqual({
-    devupApiRsbuildPlugin: expect.any(Function),
-    default: expect.any(Function),
-  })
-})

package/src/__tests__/plugin.test.ts

@@ -1,228 +0,0 @@
-import { beforeEach, expect, mock, spyOn, test } from 'bun:test'
-import { join } from 'node:path'
-import type { DevupApiOptions } from '@devup-api/core'
-import * as generator from '@devup-api/generator'
-import * as utils from '@devup-api/utils'
-import { devupApiRsbuildPlugin } from '../plugin'
-
-let mockCreateTmpDirAsync: ReturnType<typeof spyOn>
-let mockReadOpenapiAsync: ReturnType<typeof spyOn>
-let mockWriteInterfaceAsync: ReturnType<typeof spyOn>
-let mockCreateUrlMap: ReturnType<typeof spyOn>
-let mockGenerateInterface: ReturnType<typeof spyOn>
-
-const mockSchema = {
-  openapi: '3.1.0',
-  paths: {
-    '/users': {
-      get: {
-        operationId: 'getUsers',
-        responses: {
-          '200': {
-            content: {
-              'application/json': {
-                schema: {
-                  type: 'array',
-                  items: { type: 'string' },
-                },
-              },
-            },
-          },
-        },
-      },
-    },
-  },
-} as const
-
-const mockUrlMap = {
-  getUsers: {
-    method: 'GET' as const,
-    url: '/users',
-  },
-  '/users': {
-    method: 'GET' as const,
-    url: '/users',
-  },
-}
-
-const mockInterfaceContent = 'export interface Test {}'
-
-const createMockBuild = () => {
-  const modifyRsbuildConfigMock = mock(
-    (modifier: (config: unknown) => unknown) => {
-      const config = { source: { define: {} } }
-      return modifier(config)
-    },
-  )
-  return {
-    modifyRsbuildConfig: modifyRsbuildConfigMock,
-  }
-}
-
-beforeEach(() => {
-  mockCreateTmpDirAsync = spyOn(utils, 'createTmpDirAsync').mockResolvedValue(
-    'df',
-  )
-  mockReadOpenapiAsync = spyOn(utils, 'readOpenapiAsync').mockResolvedValue(
-    mockSchema as never,
-  )
-  mockWriteInterfaceAsync = spyOn(
-    utils,
-    'writeInterfaceAsync',
-  ).mockResolvedValue(undefined)
-  mockCreateUrlMap = spyOn(generator, 'createUrlMap').mockReturnValue(
-    mockUrlMap as never,
-  )
-  mockGenerateInterface = spyOn(generator, 'generateInterface').mockReturnValue(
-    mockInterfaceContent,
-  )
-  mockCreateTmpDirAsync.mockClear()
-  mockReadOpenapiAsync.mockClear()
-  mockWriteInterfaceAsync.mockClear()
-  mockCreateUrlMap.mockClear()
-  mockGenerateInterface.mockClear()
-})
-
-test('devupApiRsbuildPlugin returns plugin with correct name', () => {
-  const plugin = devupApiRsbuildPlugin()
-  expect(plugin.name).toBe('devup-api')
-})
-
-test.each([
-  [undefined],
-  [{ tempDir: 'custom-dir' }],
-  [{ openapiFile: 'custom-openapi.json' }],
-  [
-    {
-      tempDir: 'custom-dir',
-      openapiFile: 'custom-openapi.json',
-      convertCase: 'snake' as const,
-    },
-  ],
-] as const)('devupApiRsbuildPlugin returns plugin with setup hook: %s', async (options:
-  | DevupApiOptions
-  | undefined) => {
-  const plugin = devupApiRsbuildPlugin(options)
-  expect(plugin.setup).toBeDefined()
-  expect(typeof plugin.setup).toBe('function')
-
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  expect(mockCreateTmpDirAsync).toHaveBeenCalledWith(options?.tempDir)
-  expect(mockReadOpenapiAsync).toHaveBeenCalledWith(options?.openapiFile)
-  expect(mockGenerateInterface).toHaveBeenCalledWith(mockSchema, options)
-  expect(mockWriteInterfaceAsync).toHaveBeenCalledWith(
-    join('df', 'api.d.ts'),
-    mockInterfaceContent,
-  )
-  expect(mockCreateUrlMap).toHaveBeenCalledWith(mockSchema, options)
-  expect(build.modifyRsbuildConfig).toHaveBeenCalled()
-})
-
-test('devupApiRsbuildPlugin setup hook modifies config with urlMap', async () => {
-  const plugin = devupApiRsbuildPlugin()
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  const configModifier = (build.modifyRsbuildConfig as ReturnType<typeof mock>)
-    .mock.calls[0]?.[0] as (config: {
-    source?: { define?: Record<string, string> }
-  }) => unknown
-  const config = { source: { define: {} } }
-  const result = configModifier(config)
-
-  expect(result).toEqual({
-    source: {
-      define: {
-        'process.env.DEVUP_API_URL_MAP': JSON.stringify(
-          JSON.stringify(mockUrlMap),
-        ),
-      },
-    },
-  })
-})
-
-test('devupApiRsbuildPlugin setup hook handles config without source', async () => {
-  const plugin = devupApiRsbuildPlugin()
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  const configModifier = (build.modifyRsbuildConfig as ReturnType<typeof mock>)
-    .mock.calls[0]?.[0] as (config: Record<string, unknown>) => unknown
-  const config = {}
-  const result = configModifier(config)
-
-  expect(result).toEqual({
-    source: {
-      define: {
-        'process.env.DEVUP_API_URL_MAP': JSON.stringify(
-          JSON.stringify(mockUrlMap),
-        ),
-      },
-    },
-  })
-})
-
-test('devupApiRsbuildPlugin setup hook handles config without define', async () => {
-  const plugin = devupApiRsbuildPlugin()
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  const configModifier = (build.modifyRsbuildConfig as ReturnType<typeof mock>)
-    .mock.calls[0]?.[0] as (config: {
-    source?: Record<string, unknown>
-  }) => unknown
-  const config = { source: {} }
-  const result = configModifier(config)
-
-  expect(result).toEqual({
-    source: {
-      define: {
-        'process.env.DEVUP_API_URL_MAP': JSON.stringify(
-          JSON.stringify(mockUrlMap),
-        ),
-      },
-    },
-  })
-})
-
-test('devupApiRsbuildPlugin setup hook does not add urlMap when urlMap is null', async () => {
-  mockCreateUrlMap.mockReturnValueOnce(null as never)
-  const plugin = devupApiRsbuildPlugin()
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  const configModifier = (build.modifyRsbuildConfig as ReturnType<typeof mock>)
-    .mock.calls[0]?.[0] as (config: {
-    source?: { define?: Record<string, string> }
-  }) => unknown
-  const config = { source: { define: {} } }
-  const result = configModifier(config)
-
-  expect(result).toEqual({
-    source: {
-      define: {},
-    },
-  })
-})
-
-test('devupApiRsbuildPlugin setup hook does not add urlMap when urlMap is undefined', async () => {
-  mockCreateUrlMap.mockReturnValueOnce(undefined as never)
-  const plugin = devupApiRsbuildPlugin()
-  const build = createMockBuild()
-  await plugin.setup?.(build as never)
-
-  const configModifier = (build.modifyRsbuildConfig as ReturnType<typeof mock>)
-    .mock.calls[0]?.[0] as (config: {
-    source?: { define?: Record<string, string> }
-  }) => unknown
-  const config = { source: { define: {} } }
-  const result = configModifier(config)
-
-  expect(result).toEqual({
-    source: {
-      define: {},
-    },
-  })
-})

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './plugin'
-export { devupApiRsbuildPlugin as default } from './plugin'

package/src/plugin.ts

@@ -1,40 +0,0 @@
-import { join } from 'node:path'
-import type { DevupApiOptions } from '@devup-api/core'
-import { createUrlMap, generateInterface } from '@devup-api/generator'
-import {
-  createTmpDirAsync,
-  readOpenapiAsync,
-  writeInterfaceAsync,
-} from '@devup-api/utils'
-import type { RsbuildPlugin } from '@rsbuild/core'
-
-export function devupApiRsbuildPlugin(
-  options?: DevupApiOptions,
-): RsbuildPlugin {
-  return {
-    name: 'devup-api',
-    async setup(build) {
-      const tempDir = await createTmpDirAsync(options?.tempDir)
-      const schema = await readOpenapiAsync(options?.openapiFile)
-
-      // Generate interface file
-      await writeInterfaceAsync(
-        join(tempDir, 'api.d.ts'),
-        generateInterface(schema, options),
-      )
-
-      // Create urlMap and set environment variable
-      const urlMap = createUrlMap(schema, options)
-
-      build.modifyRsbuildConfig((config) => {
-        config.source ??= {}
-        config.source.define ??= {}
-        if (urlMap) {
-          config.source.define['process.env.DEVUP_API_URL_MAP'] =
-            JSON.stringify(JSON.stringify(urlMap))
-        }
-        return config
-      })
-    },
-  }
-}

package/tsconfig.json

@@ -1,34 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "verbatimModuleSyntax": true,
-    "emitDeclarationOnly": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false,
-    "declaration": true,
-    "declarationMap": true,
-    "outDir": "dist",
-    "rootDir": "src"
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["dist", "node_modules"]
-}