jax-hono 1.0.28 → 1.0.29

package/build/generate-config.ts

@@ -4,9 +4,10 @@ import { join, parse, relative } from 'node:path'
 import { ensureGeneratedDir, generatedDir, projectDir } from './generated-path'
 
 const srcDir = join(cwd(), 'src')
-const configDir = join(srcDir, 'config')
-const typesFile = join(srcDir, 'types/index.ts')
-const outputFile = join(generatedDir, 'config.ts')
+const configDir = join(srcDir, 'config')
+const typesFile = join(srcDir, 'types/index.ts')
+const outputFile = join(generatedDir, 'config.ts')
+const typeAugmentationFile = join(srcDir, 'jax-hono.generated.d.ts')
 const envStages = new Set([
   'default',
   'local',
@@ -64,15 +65,24 @@ function getConfigFiles() {
     })
 }
 
-function hasProjectConfigType() {
+function hasProjectConfigType() {
   if (!existsSync(typesFile)) {
     return false
   }
 
   const source = readFileSync(typesFile, 'utf8')
 
-  return /\bexport\s+(?:type|interface)\s+ProjectConfig\b/.test(source)
-}
+  return /\bexport\s+(?:type|interface)\s+ProjectConfig\b/.test(source)
+}
+
+function writeIfChanged(filePath: string, content: string, message: string) {
+  if (existsSync(filePath) && readFileSync(filePath, 'utf8') === content) {
+    return
+  }
+
+  writeFileSync(filePath, content)
+  console.log(message)
+}
 
 export function generateConfig() {
   const files = getConfigFiles()
@@ -82,40 +92,45 @@ export function generateConfig() {
   })
   const modules = files.map((fileName, index) => {
     return `  { name: '${fileName}', stage: '${getStage(fileName)}', config: ${toImportName(fileName, index)} },`
-  })
-  const hasProjectTypes = hasProjectConfigType()
-  const typeImports = hasProjectTypes ? [`import type { ProjectConfig } from '${join(srcDir, 'types').replaceAll('\\', '/')}'`] : []
-  const projectConfigType = hasProjectTypes
-    ? 'export type { ProjectConfig }'
-    : defaultConfigIndex === -1
+  })
+  const hasProjectTypes = hasProjectConfigType()
+  const typeImports = [
+    `import { config as jaxConfig, type JaxConfig } from 'jax-hono'`,
+    ...(hasProjectTypes ? [`import type { ProjectConfig } from '${join(srcDir, 'types').replaceAll('\\', '/')}'`] : []),
+  ]
+  const projectConfigType = hasProjectTypes
+    ? 'export type { ProjectConfig }'
+    : defaultConfigIndex === -1
     ? 'export type ProjectConfig = Record<string, unknown>'
     : `export type ProjectConfig = typeof ${toImportName(files[defaultConfigIndex], defaultConfigIndex)}`
   const content = `${[...typeImports, ...imports].join('\n')}
 
 export const configModules = [
 ${modules.join('\n')}
-] as const
-
-${projectConfigType}
-
-declare module 'jax-hono/core/generated' {
-  interface JaxGenerated {
+] as const
+
+${projectConfigType}
+export type Config = JaxConfig & ProjectConfig
+
+export const config = jaxConfig as Config
+
+declare module 'jax-hono/core/generated' {
+  interface JaxGenerated {
     config: ProjectConfig
   }
 }
-
-export default configModules
-`
-
-  ensureGeneratedDir()
-
-  if (existsSync(outputFile) && readFileSync(outputFile, 'utf8') === content) {
-    return
-  }
-
-  writeFileSync(outputFile, content)
-  console.log(`Generated ${relative(projectDir, outputFile)} with ${files.length} config file(s).`)
-}
+
+export default configModules
+`
+  const typeAugmentationContent = `import '../.jax-hono/config'
+
+export {}
+`
+
+  ensureGeneratedDir()
+  writeIfChanged(outputFile, content, `Generated ${relative(projectDir, outputFile)} with ${files.length} config file(s).`)
+  writeIfChanged(typeAugmentationFile, typeAugmentationContent, `Generated ${relative(projectDir, typeAugmentationFile)}.`)
+}
 
 if (import.meta.main) {
   generateConfig()

package/build/generate-registry.ts

@@ -5,11 +5,12 @@ import { basename, dirname, isAbsolute, join, parse, relative, resolve } from 'n
 import { ensureGeneratedDir, generatedDir, packageDir, projectDir } from './generated-path'
 
 const srcDir = join(cwd(), 'src')
-const projectRequire = createRequire(join(projectDir, 'package.json'))
-const moduleExtensions = new Set(['.ts', '.js', '.mjs', '.cjs'])
-const generatedHeader = `// This file is generated by jax-hono/build/generate-registry.ts.
-// Do not edit it directly.
-`
+const projectRequire = createRequire(join(projectDir, 'package.json'))
+const moduleExtensions = new Set(['.ts', '.js', '.mjs', '.cjs'])
+const warnedPluginPackages = new Set<string>()
+const generatedHeader = `// This file is generated by jax-hono/build/generate-registry.ts.
+// Do not edit it directly.
+`
 
 type ControllerGroup = {
   name: string
@@ -27,11 +28,12 @@ type PluginConfigItem =
 
 type PluginConfig = Record<string, PluginConfigItem>
 
-type EnabledPlugin = {
-  name: string
-  packageName: string
-  rootDir: string
-}
+type EnabledPlugin = {
+  name: string
+  packageName: string
+  rootDir: string
+  options?: unknown
+}
 
 type PluginFile = EnabledPlugin & {
   filePath: string
@@ -782,13 +784,35 @@ function getEnabledPluginConfigItems() {
   ])
 }
 
-function resolvePluginPackageDir(packageName: string) {
-  const resolved = resolvePluginPackage(packageName)
-
-  return statSync(resolved).isDirectory()
-    ? resolved
-    : dirname(resolved)
-}
+function resolvePluginPackageDir(packageName: string) {
+  const resolved = resolvePluginPackage(packageName)
+
+  return statSync(resolved).isDirectory()
+    ? resolved
+    : dirname(resolved)
+}
+
+function tryResolvePlugin(name: string, item: Exclude<PluginConfigItem, false> & { package: string }): EnabledPlugin | undefined {
+  try {
+    return {
+      name,
+      packageName: item.package,
+      rootDir: resolvePluginPackageDir(item.package),
+      options: item.options,
+    }
+  } catch (error) {
+    const warningKey = `${name}:${item.package}`
+
+    if (!warnedPluginPackages.has(warningKey)) {
+      warnedPluginPackages.add(warningKey)
+      console.warn(
+        `[plugins] package not found [${name}]: ${item.package} (${(error as Error).message})`,
+      )
+    }
+
+    return undefined
+  }
+}
 
 function resolvePluginPackage(packageName: string) {
   if (isAbsolute(packageName)) {
@@ -817,19 +841,12 @@ function resolvePluginPackage(packageName: string) {
   return projectRequire.resolve(packageName)
 }
 
-function getEnabledPlugins(): EnabledPlugin[] {
-  return getEnabledPluginConfigItems()
-    .map(([name, item]) => {
-      const rootDir = resolvePluginPackageDir(item.package)
-
-      return {
-        name,
-        packageName: item.package,
-        rootDir,
-      }
-    })
-    .filter((plugin) => existsSync(plugin.rootDir))
-}
+function getEnabledPlugins(): EnabledPlugin[] {
+  return getEnabledPluginConfigItems()
+    .map(([name, item]) => tryResolvePlugin(name, item))
+    .filter((plugin): plugin is EnabledPlugin => Boolean(plugin))
+    .filter((plugin) => existsSync(plugin.rootDir))
+}
 
 function serializePluginOptions(options: unknown) {
   return options === undefined ? '' : `, options: ${JSON.stringify(options)}`
@@ -855,26 +872,29 @@ function pluginExportsJaxPluginContext(rootDir: string) {
   return false
 }
 
-function generatePluginContextRegistry() {
-  const enabledPlugins = getEnabledPluginConfigItems()
-  const imports = enabledPlugins.map(([name, item]) => {
-    return `import ${toLowerCamelIdentifier([name], 'Plugin')} from ${JSON.stringify(item.package)}`
-  })
-  const pluginContexts = enabledPlugins
-    .filter(([, item]) => pluginExportsJaxPluginContext(resolvePluginPackageDir(item.package)))
-    .map(([name, item]) => ({
-      importName: toLowerCamelIdentifier([name], 'PluginContext'),
-      packageName: item.package,
-    }))
+function generatePluginContextRegistry() {
+  const enabledPlugins = getEnabledPluginConfigItems()
+    .map(([name, item]) => tryResolvePlugin(name, item))
+    .filter((plugin): plugin is EnabledPlugin => Boolean(plugin))
+    .filter((plugin) => existsSync(plugin.rootDir))
+  const imports = enabledPlugins.map((plugin) => {
+    return `import ${toLowerCamelIdentifier([plugin.name], 'Plugin')} from ${JSON.stringify(plugin.packageName)}`
+  })
+  const pluginContexts = enabledPlugins
+    .filter((plugin) => pluginExportsJaxPluginContext(plugin.rootDir))
+    .map((plugin) => ({
+      importName: toLowerCamelIdentifier([plugin.name], 'PluginContext'),
+      packageName: plugin.packageName,
+    }))
   const contextImports = pluginContexts.map(({ importName, packageName }) => {
     return `import type { JaxPluginContext as ${importName} } from ${JSON.stringify(packageName)}`
   })
   const pluginContextTypes = pluginContexts.map(({ importName }) => importName)
-  const exportNames = enabledPlugins.map(([name]) => toLowerCamelIdentifier([name], 'Plugin'))
-  const moduleEntries = enabledPlugins.map(
-    ([name, item]) =>
-      `  { name: ${JSON.stringify(name)}, module: ${toLowerCamelIdentifier([name], 'Plugin')}${serializePluginOptions(item.options)} },`,
-  )
+  const exportNames = enabledPlugins.map((plugin) => toLowerCamelIdentifier([plugin.name], 'Plugin'))
+  const moduleEntries = enabledPlugins.map(
+    (plugin) =>
+      `  { name: ${JSON.stringify(plugin.name)}, module: ${toLowerCamelIdentifier([plugin.name], 'Plugin')}${serializePluginOptions(plugin.options)} },`,
+  )
   const exportBlock = formatExportBlock(exportNames)
   const pluginsType = ['Record<string, unknown>', ...pluginContextTypes].join(' & ')
 
@@ -906,23 +926,24 @@ import * as configModule from './config'
 import * as controllersModule from './controllers.generated'
 import * as middlewaresModule from './middlewares.generated'
 import * as modelsModule from './models.generated'
-import * as servicesModule from './services.generated'
-import * as cronsModule from './crons.generated'
-import * as pluginsModule from './plugins.generated'
-import { registerGeneratedModules } from 'jax-hono/core/generated'
-
-registerGeneratedModules({
-  'config.ts': configModule,
-  'controllers.generated.ts': controllersModule,
+import * as servicesModule from './services.generated'
+import * as cronsModule from './crons.generated'
+import * as pluginsModule from './plugins.generated'
+import { registerGeneratedModules } from 'jax-hono/core/generated'
+
+registerGeneratedModules({
+  'config.ts': configModule,
+  'controllers.generated.ts': controllersModule,
   'middlewares.generated.ts': middlewaresModule,
   'models.generated.ts': modelsModule,
   'services.generated.ts': servicesModule,
   'crons.generated.ts': cronsModule,
-  'plugins.generated.ts': pluginsModule,
-})
-
-export * from 'jax-hono'
-`
+  'plugins.generated.ts': pluginsModule,
+})
+
+export * from 'jax-hono'
+export { config } from './config'
+`
 
   writeGeneratedFile('index.ts', content)
 }

package/index.ts

@@ -103,7 +103,7 @@ export const createServices: CreateServices = ((deps: unknown) => {
   return getCreateServices()(deps);
 }) as CreateServices;
 
-export const config = new Proxy({} as Config, {
+export const config: Config = new Proxy<Config>({} as Config, {
   get(_target, property, receiver) {
     return Reflect.get(getConfig(), property, receiver);
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jax-hono",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "description": "Lightweight framework layer on top of Hono, built for Bun",
   "type": "module",
   "main": "./index.ts",