jax-hono 1.0.0 → 1.0.1

package/bin/jax.ts

@@ -3,17 +3,31 @@
 import { cac } from "cac";
 import { $ } from "bun";
 import path from "node:path";
+import { existsSync } from "node:fs";
+import { mkdir } from "node:fs/promises";
 
 const cli = cac("jax");
 
 cli
   .command(
     "link",
-    "Create a symlink (./jax -> jax-hono installation directory)",
+    "Create a symlink to the jax-hono installation directory",
   )
   .action(async () => {
+    const cwd = process.cwd();
     const sourceDir = path.resolve(import.meta.dir, "..");
-    const targetDir = path.resolve(process.cwd(), "jax");
+    const shouldUseNodeModules =
+      existsSync(path.join(cwd, "package.json")) ||
+      existsSync(path.join(cwd, "node_modules"));
+    const targetRoot = shouldUseNodeModules
+      ? path.join(cwd, "node_modules")
+      : cwd;
+    const targetName = shouldUseNodeModules ? "jax-hono" : "jax";
+    const targetDir = path.resolve(targetRoot, targetName);
+
+    if (shouldUseNodeModules) {
+      await mkdir(targetRoot, { recursive: true });
+    }
 
     if (process.platform === "win32") {
       const result =

package/build/generate-config.ts

@@ -1,10 +1,12 @@
 import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs'
+import { cwd } from 'node:process'
 import { join, parse, relative } from 'node:path'
 
-const srcDir = join(import.meta.dir, '../..')
+const packageDir = join(import.meta.dir, '..')
+const srcDir = join(cwd(), 'src')
 const configDir = join(srcDir, 'config')
 const typesFile = join(srcDir, 'types/index.ts')
-const generatedDir = join(srcDir, 'jax/generated')
+const generatedDir = join(packageDir, 'generated')
 const outputFile = join(generatedDir, 'config.ts')
 const envStages = new Set([
   'default',
@@ -35,9 +37,9 @@ function getStage(fileName: string) {
 
 function getImportPath(fileName: string) {
   const { dir, name } = parse(fileName)
-  const path = join('../../config', dir, name).replaceAll('\\', '/')
+  const path = join(configDir, dir, name).replaceAll('\\', '/')
 
-  return path.startsWith('.') ? path : `./${path}`
+  return path
 }
 
 function getConfigFiles() {
@@ -83,7 +85,7 @@ export function generateConfig() {
     return `  { name: '${fileName}', stage: '${getStage(fileName)}', config: ${toImportName(fileName, index)} },`
   })
   const hasProjectTypes = hasProjectConfigType()
-  const typeImports = hasProjectTypes ? [`import type { ProjectConfig } from '../../types'`] : []
+  const typeImports = hasProjectTypes ? [`import type { ProjectConfig } from '${join(srcDir, 'types').replaceAll('\\', '/')}'`] : []
   const projectConfigType = hasProjectTypes
     ? 'export type { ProjectConfig }'
     : defaultConfigIndex === -1

package/build/generate-registry.ts

@@ -1,10 +1,12 @@
 import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs'
+import { cwd } from 'node:process'
 import { basename, join, parse, relative } from 'node:path'
 
-const srcDir = join(import.meta.dir, '../..')
-const generatedDir = join(srcDir, 'jax/generated')
+const packageDir = join(import.meta.dir, '..')
+const srcDir = join(cwd(), 'src')
+const generatedDir = join(packageDir, 'generated')
 const moduleExtensions = new Set(['.ts', '.js', '.mjs', '.cjs'])
-const generatedHeader = `// This file is generated by src/jax/build/generate-registry.ts.
+const generatedHeader = `// This file is generated by jax-hono/build/generate-registry.ts.
 // Do not edit it directly.
 `
 
@@ -75,11 +77,11 @@ function writeGeneratedFile(fileName: string, content: string) {
 }
 
 function toImportPath(filePath: string) {
-  const path = relative(srcDir, filePath)
+  const path = filePath
     .replace(parse(filePath).ext, '')
     .replaceAll('\\', '/')
 
-  return `@/${path}`
+  return path
 }
 
 function toIdentifier(parts: string[]) {
@@ -277,7 +279,7 @@ function generateControllersRegistry() {
   }
 
   const helperImport = imports.length > 0
-    ? `import { createController } from '@/jax/core/controller'\n`
+    ? `import { createController } from 'jax-hono/core/controller'\n`
     : ''
   const content = `${generatedHeader}
 ${helperImport}${imports.join('\n')}
@@ -531,15 +533,11 @@ function normalizePluginPackage(packageName: string, configFile: string) {
     return packageName
   }
 
-  const normalized = relative(srcDir, join(configFile, '..', packageName))
+  const normalized = join(configFile, '..', packageName)
     .replaceAll('\\', '/')
     .replace(/\/index$/, '')
 
-  if (normalized.startsWith('jax/')) {
-    return normalized
-  }
-
-  return `@/${normalized}`
+  return normalized
 }
 
 function mergePluginConfig(configs: { filePath: string; config: PluginConfig }[]) {
@@ -578,7 +576,6 @@ function serializePluginOptions(options: unknown) {
 
 function generatePluginContextRegistry() {
   const enabledPlugins = mergePluginConfig([
-    { filePath: join(srcDir, 'jax/plugins/config.ts'), config: readPluginConfig(join(srcDir, 'jax/plugins/config.ts')) },
     { filePath: join(srcDir, 'config/plugin.ts'), config: readPluginConfig(join(srcDir, 'config/plugin.ts')) },
   ])
   const imports = enabledPlugins.map(([name, item]) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jax-hono",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Lightweight framework layer on top of Hono, built for Bun",
   "type": "module",
   "main": "./index.ts",
@@ -10,7 +10,54 @@
       "import": "./index.ts",
       "types": "./index.ts"
     },
-    "./*": "./*"
+    "./setup": {
+      "import": "./setup.ts",
+      "types": "./setup.ts"
+    },
+    "./config": {
+      "import": "./config.ts",
+      "types": "./config.ts"
+    },
+    "./core/*": {
+      "import": "./core/*.ts",
+      "types": "./core/*.ts"
+    },
+    "./helpers": {
+      "import": "./helpers/index.ts",
+      "types": "./helpers/index.ts"
+    },
+    "./helpers/*": {
+      "import": "./helpers/*.ts",
+      "types": "./helpers/*.ts"
+    },
+    "./middleware/*": {
+      "import": "./middleware/*.ts",
+      "types": "./middleware/*.ts"
+    },
+    "./plugins/*": {
+      "import": "./plugins/*/index.ts",
+      "types": "./plugins/*/index.ts"
+    },
+    "./plugins/*/*": {
+      "import": "./plugins/*/*.ts",
+      "types": "./plugins/*/*.ts"
+    },
+    "./utils": {
+      "import": "./utils/index.ts",
+      "types": "./utils/index.ts"
+    },
+    "./utils/*": {
+      "import": "./utils/*.ts",
+      "types": "./utils/*.ts"
+    },
+    "./types": {
+      "import": "./types/index.ts",
+      "types": "./types/index.ts"
+    },
+    "./types/*": {
+      "import": "./types/*.ts",
+      "types": "./types/*.ts"
+    }
   },
   "bin": {
     "jax": "./bin/jax.ts"
@@ -40,12 +87,20 @@
   },
   "peerDependencies": {
     "dayjs": "*",
-    "deepmerge": "*",
-    "dotenv": "*",
+    "deepmerge": "^4.3.1",
+    "dotenv": "^17.4.2",
     "jsonwebtoken": "*",
-    "minimist": "*",
+    "minimist": "^1.2.8",
     "mongoose": "*"
   },
+  "devDependencies": {
+    "dayjs": "^1.11.21",
+    "deepmerge": "^4.3.1",
+    "dotenv": "^17.4.2",
+    "jsonwebtoken": "^9.0.3",
+    "minimist": "^1.2.8",
+    "mongoose": "^8.24.1"
+  },
   "peerDependenciesMeta": {
     "dayjs": {
       "optional": true
@@ -61,4 +116,4 @@
     "bun": ">=1.0.0"
   },
   "license": "MIT"
-}
+}

package/plugins/mongoose/model.ts

@@ -1,14 +1,14 @@
-import { basename, parse } from 'node:path';
+import { basename, parse } from "node:path";
 import mongoose, {
   Schema,
   model as mongooseModel,
   type InferSchemaType,
   type Model,
-  type SchemaOptions
-} from 'mongoose';
-import config from '@/jax/config';
-import { rankSetter } from './schema';
-import dayjs from 'dayjs';
+  type SchemaOptions,
+} from "mongoose";
+import config from "@/config";
+import { rankSetter } from "./schema";
+import dayjs from "dayjs";
 
 export { rankSetter };
 
@@ -21,7 +21,7 @@ type PageOptions = {
 export type ModelStatics = {
   findPage(
     filter?: Record<string, unknown>,
-    options?: PageOptions
+    options?: PageOptions,
   ): Promise<{
     total: number;
     list: unknown[];
@@ -48,14 +48,15 @@ export function createLooseModel(filePathOrName: string, collection?: string) {
   installModelStatics(schema);
 
   return (
-    mongoose.models[name] ?? mongooseModel(name, schema, collection ?? getCollectionName(name))
+    mongoose.models[name] ??
+    mongooseModel(name, schema, collection ?? getCollectionName(name))
   );
 }
 
 export function createSchemaModel<TSchema extends Schema>(
   filePathOrName: string,
   schema: TSchema,
-  collection?: string
+  collection?: string,
 ): Model<InferSchemaType<TSchema>> & ModelStatics {
   const name = getModelName(filePathOrName);
 
@@ -67,7 +68,7 @@ export function createSchemaModel<TSchema extends Schema>(
     mongooseModel<InferSchemaType<TSchema>>(
       name,
       schema as any,
-      collection ?? getCollectionName(name)
+      collection ?? getCollectionName(name),
     )) as Model<InferSchemaType<TSchema>> & ModelStatics;
 }
 
@@ -75,15 +76,16 @@ export const createModel = createSchemaModel;
 
 export function getModelName(filePathOrName: string) {
   const baseName =
-    filePathOrName.includes('/') || filePathOrName.includes('\\')
-      ? parse(basename(filePathOrName)).name.replace(/\.model$/, '')
+    filePathOrName.includes("/") || filePathOrName.includes("\\")
+      ? parse(basename(filePathOrName)).name.replace(/\.model$/, "")
       : filePathOrName;
 
   return toPascalCase(baseName);
 }
 
 export function getCollectionName(modelName: string) {
-  const prefix = (config as any).mongoose?.prefix ?? (config as any).mongo?.prefix ?? '';
+  const prefix =
+    (config as any).mongoose?.prefix ?? (config as any).mongo?.prefix ?? "";
   const name = toSnakeCase(modelName);
 
   return prefix ? `${prefix}_${name}` : name;
@@ -102,23 +104,23 @@ export function schemaOptions(): SchemaOptions {
         // }
 
         if (ret.createdAt) {
-          ret.createdAt = dayjs(ret.createdAt).format('YYYY-MM-DD HH:mm:ss');
+          ret.createdAt = dayjs(ret.createdAt).format("YYYY-MM-DD HH:mm:ss");
         }
 
         if (ret.updatedAt) {
-          ret.updatedAt = dayjs(ret.updatedAt).format('YYYY-MM-DD HH:mm:ss');
+          ret.updatedAt = dayjs(ret.updatedAt).format("YYYY-MM-DD HH:mm:ss");
         }
 
         delete ret.__v;
         delete ret._id;
 
         return ret;
-      }
+      },
     },
     toObject: {
       virtuals: true,
-      getters: true
-    }
+      getters: true,
+    },
   };
 }
 
@@ -126,37 +128,40 @@ export function applyDefaultSchemaOptions(schema: Schema) {
   const defaults = schemaOptions();
 
   if (schema.options.timestamps === undefined) {
-    schema.set('timestamps', defaults.timestamps);
+    schema.set("timestamps", defaults.timestamps);
   }
 
-  if (schema.options.versionKey === undefined || schema.options.versionKey === '__v') {
-    schema.set('versionKey', defaults.versionKey);
+  if (
+    schema.options.versionKey === undefined ||
+    schema.options.versionKey === "__v"
+  ) {
+    schema.set("versionKey", defaults.versionKey);
   }
 
   const toJSON = {
     ...defaults.toJSON,
-    ...(schema.options.toJSON ?? {})
+    ...(schema.options.toJSON ?? {}),
   } as any;
 
-  schema.set('toJSON', toJSON);
-  schema.set('toObject', {
+  schema.set("toJSON", toJSON);
+  schema.set("toObject", {
     ...defaults.toObject,
-    ...(schema.options.toObject ?? {})
+    ...(schema.options.toObject ?? {}),
   } as any);
 }
 
 export function installRankHooks(schema: Schema) {
-  schema.pre(['updateOne', 'findOneAndUpdate', 'updateMany'], function () {
+  schema.pre(["updateOne", "findOneAndUpdate", "updateMany"], function () {
     normalizeRank(this.getUpdate());
   });
 
-  schema.pre('save', function () {
+  schema.pre("save", function () {
     normalizeRank(this);
   });
 }
 
 export function installAutoNo(schema: Schema, field: string, start = 0) {
-  schema.pre('save', async function () {
+  schema.pre("save", async function () {
     if (!this.isNew || this.get(field)) {
       return;
     }
@@ -169,29 +174,32 @@ export function installAutoNo(schema: Schema, field: string, start = 0) {
 }
 
 export function installModelStatics(schema: Schema) {
-  schema.static('findPage', async function findPage(filter = {}, options: PageOptions = {}) {
-    const page = Number(options.page || 1);
-    const pageSize = Number(options.pageSize || 20);
-    const sort = (options.sort ?? { _id: -1 }) as any;
-    const total = await this.countDocuments(filter);
-    let query = this.find(filter).sort(sort);
-
-    if (pageSize !== -1) {
-      query = query.skip((page - 1) * pageSize).limit(pageSize);
-    }
+  schema.static(
+    "findPage",
+    async function findPage(filter = {}, options: PageOptions = {}) {
+      const page = Number(options.page || 1);
+      const pageSize = Number(options.pageSize || 20);
+      const sort = (options.sort ?? { _id: -1 }) as any;
+      const total = await this.countDocuments(filter);
+      let query = this.find(filter).sort(sort);
+
+      if (pageSize !== -1) {
+        query = query.skip((page - 1) * pageSize).limit(pageSize);
+      }
 
-    const list = await query;
+      const list = await query;
 
-    return {
-      total,
-      list,
-      maxPage: pageSize === -1 ? 1 : Math.ceil(total / pageSize),
-      page,
-      pageSize
-    };
-  });
+      return {
+        total,
+        list,
+        maxPage: pageSize === -1 ? 1 : Math.ceil(total / pageSize),
+        page,
+        pageSize,
+      };
+    },
+  );
 
-  schema.static('tree', async function tree(options: any = {}) {
+  schema.static("tree", async function tree(options: any = {}) {
     const docs = await this.find(options.filter ?? {})
       .sort(options.sort ?? {})
       .lean({ virtuals: true });
@@ -204,7 +212,7 @@ export function installModelStatics(schema: Schema) {
     }
 
     for (const item of byId.values()) {
-      const parentId = item.parentId ? String(item.parentId) : '';
+      const parentId = item.parentId ? String(item.parentId) : "";
       const parent = parentId ? byId.get(parentId) : undefined;
 
       if (parent) {
@@ -217,24 +225,27 @@ export function installModelStatics(schema: Schema) {
     return tree;
   });
 
-  schema.static('flatTree', async function flatTree(this: any, options: any = {}) {
-    const tree = await this.tree(options);
-    const list: any[] = [];
+  schema.static(
+    "flatTree",
+    async function flatTree(this: any, options: any = {}) {
+      const tree = await this.tree(options);
+      const list: any[] = [];
 
-    walkTree(tree, 1, list);
+      walkTree(tree, 1, list);
 
-    return list;
-  });
+      return list;
+    },
+  );
 }
 
 export function installCommonFields(schema: Schema) {
   const fields: Record<string, unknown> = {};
 
-  if (!schema.path('isDelete')) {
+  if (!schema.path("isDelete")) {
     fields.isDelete = { type: Boolean, default: false };
   }
 
-  if (!schema.path('isOpen')) {
+  if (!schema.path("isOpen")) {
     fields.isOpen = { type: Boolean, default: false };
   }
 
@@ -245,14 +256,14 @@ export function installCommonFields(schema: Schema) {
 
 export function toSnakeCase(value: string) {
   return value
-    .replace(/([a-z0-9])([A-Z])/g, '$1_$2')
-    .replace(/[-\s]+/g, '_')
+    .replace(/([a-z0-9])([A-Z])/g, "$1_$2")
+    .replace(/[-\s]+/g, "_")
     .toLowerCase();
 }
 
 function toPascalCase(value: string) {
   const camel = value.replace(/[-_\s]+([a-zA-Z0-9])/g, (_match, char: string) =>
-    char.toUpperCase()
+    char.toUpperCase(),
   );
 
   return camel.charAt(0).toUpperCase() + camel.slice(1);