@jayfong/x-server 1.8.0 → 1.10.2

package/CHANGELOG.md

@@ -2,6 +2,47 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.10.2](https://github.com/jfWorks/x-server/compare/v1.10.1...v1.10.2) (2022-04-19)
+
+
+### Bug Fixes
+
+* api gen ([cc33df1](https://github.com/jfWorks/x-server/commit/cc33df1bf15c2b367b1a62cf920a1a1184c20339))
+
+### [1.10.1](https://github.com/jfWorks/x-server/compare/v1.10.0...v1.10.1) (2022-04-19)
+
+## [1.10.0](https://github.com/jfWorks/x-server/compare/v1.8.0...v1.10.0) (2022-04-19)
+
+
+### Features
+
+* use esbuild-register ([0b004db](https://github.com/jfWorks/x-server/commit/0b004db9a048d0faaf528c0d8030bf0ccfb8e2b3))
+
+
+### Bug Fixes
+
+* template ([0f9bd05](https://github.com/jfWorks/x-server/commit/0f9bd0589d101de6f78f13f185ef9220edc887a7))
+* watcher initial ([82511a1](https://github.com/jfWorks/x-server/commit/82511a1bc9d1ccf4d96aa7a8ae7ee3d50a8ec2db))
+
+## [1.9.0](https://github.com/jfWorks/x-server/compare/v1.7.2...v1.9.0) (2022-04-18)
+
+
+### Features
+
+* 更改包名为 @jayfong/x-server ([1be9998](https://github.com/jfWorks/x-server/commit/1be9998070cc0960aeef2d333356f66a22bb5766))
+* 移除 cwd 选项 ([12cfa42](https://github.com/jfWorks/x-server/commit/12cfa4222ec8d69d73f2b38a68ea6aa975dbe575))
+* npc ([5d314ea](https://github.com/jfWorks/x-server/commit/5d314ea341a72ae5b09db979d5d2b63ffadf0670))
+* plugins ([1df0cd1](https://github.com/jfWorks/x-server/commit/1df0cd10ccf170d9e7180abf9d27416304856894))
+* service 通过 x 提供 ([a159154](https://github.com/jfWorks/x-server/commit/a1591541e865e755d4d6dbdeb405d5d08b334a4a))
+* templates ([deeb0d6](https://github.com/jfWorks/x-server/commit/deeb0d643bdf04d04533d20bd1d5a068b178347a))
+* use esbuild-register ([0b004db](https://github.com/jfWorks/x-server/commit/0b004db9a048d0faaf528c0d8030bf0ccfb8e2b3))
+
+
+### Bug Fixes
+
+* template ([0f9bd05](https://github.com/jfWorks/x-server/commit/0f9bd0589d101de6f78f13f185ef9220edc887a7))
+* test ([994845b](https://github.com/jfWorks/x-server/commit/994845b0e2ac84ce050494de27b705c1e45fb343))
+
 ## [1.8.0](https://github.com/jfWorks/x-server/compare/v1.7.2...v1.8.0) (2022-04-18)
 
 

package/lib/cli/api_generator.js

@@ -273,7 +273,7 @@ class ApiGenerator {
             tsConfigFilePath: node_path_1.default.join(this.cwd, 'tsconfig.json'),
         });
         this.debug('加载文件...');
-        const sourceFile = this.project.getSourceFileOrThrow(node_path_1.default.join(this.cwd, 'src/generated/handlers.ts'));
+        const sourceFile = this.project.createSourceFile(node_path_1.default.join(this.cwd, 'src/generated/handlers.ts'), await fs_extra_1.default.readFile(node_path_1.default.join(this.cwd, 'node_modules/.x/handlers.ts'), 'utf-8'));
         this.debug('导出处理器...');
         const handlerGroup = sourceFile.getExportSymbols();
         const handles = [];

package/lib/cli/cli.js

@@ -27,9 +27,6 @@ yargs_1.default
     type: 'string',
 }), async (argv) => {
     process.env.NODE_ENV = 'development';
-    const watcher = chokidar_1.default.watch(['src', '.env'], {
-        cwd: process.cwd(),
-    });
     let lastRun;
     const run = () => {
         lastRun = (0, execa_1.default)('node', ['-r', require.resolve('./register'), 'src/main.ts'], {
@@ -51,7 +48,13 @@ yargs_1.default
             stdio: 'inherit',
         });
     }
-    await template_util_1.TemplateUtil.init(process.cwd());
+    await Promise.all([
+        template_util_1.TemplateUtil.initHelperPackage(process.cwd()),
+        template_util_1.TemplateUtil.initModels(process.cwd()),
+    ]);
+    const watcher = chokidar_1.default.watch(['src', '.env'], {
+        cwd: process.cwd(),
+    });
     watcher.on('all', (0, vtils_1.debounce)(async () => {
         await env_util_1.EnvUtil.importFile({
             cwd: process.cwd(),
@@ -101,7 +104,7 @@ yargs_1.default
         value: 'production',
         comment: '',
     });
-    await template_util_1.TemplateUtil.init(process.cwd());
+    await template_util_1.TemplateUtil.initHelperPackage(process.cwd());
     await (0, vscode_generate_index_standalone_1.generateManyIndex)({
         cwd: process.cwd(),
         patterns: ['src/.x/*.ts'],

package/lib/cli/register.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cli/register.js

@@ -1,5 +1,7 @@
 "use strict";
-require('esbuild-runner').install({
-    type: 'transform',
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_1 = require("esbuild-register/dist/node");
+(0, node_1.register)({
+    hookIgnoreNodeModules: false,
+    hookMatcher: filename => filename.includes('/.x/') || !filename.includes('/node_modules/'),
 });
-require('tsconfig-paths/register');

package/lib/cli/template_util.d.ts

@@ -1,3 +1,10 @@
 export declare class TemplateUtil {
-    static init(cwd: string): Promise<void>;
+    /**
+     * 初始化辅助包。
+     */
+    static initHelperPackage(cwd: string): Promise<void>;
+    /**
+     * 初始化模型。
+     */
+    static initModels(cwd: string): Promise<void>;
 }

package/lib/cli/template_util.js

@@ -6,13 +6,51 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateUtil = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
+const vtils_1 = require("vtils");
 class TemplateUtil {
-    static async init(cwd) {
+    /**
+     * 初始化辅助包。
+     */
+    static async initHelperPackage(cwd) {
         const fromDir = path_1.default.join(__dirname, 'templates');
         const toDir = path_1.default.join(cwd, 'node_modules/.x');
         await fs_extra_1.default.copy(fromDir, toDir, {
             overwrite: true,
         });
     }
+    /**
+     * 初始化模型。
+     */
+    static async initModels(cwd) {
+        const modelsDir = path_1.default.join(cwd, 'src/models');
+        const indexFile = path_1.default.join(modelsDir, 'index.ts');
+        if (!(await fs_extra_1.default.pathExists(indexFile))) {
+            await fs_extra_1.default.outputFile(indexFile, (0, vtils_1.dedent) `
+          // @index(['./**/*.ts', '!**/*.test.ts', '!**/_*'], f => \`export * from '\${f.path}'\`)
+          // @endindex
+        `);
+        }
+        const prismaClientFile = path_1.default.join(cwd, 'node_modules/.prisma/client/index.d.ts');
+        const prismaClientFileContent = await fs_extra_1.default.readFile(prismaClientFile, 'utf8');
+        const modelNames = [
+            ...prismaClientFileContent
+                .match(/(?<=const ModelName:).+?(?=\})/s)[0]
+                .matchAll(/(\S+?):/g),
+        ].map(match => (0, vtils_1.camelCase)(match[1]));
+        await Promise.all(modelNames.map(async (modelName) => {
+            const model_name = (0, vtils_1.snakeCase)(modelName);
+            const ModelName = (0, vtils_1.upperFirst)(modelName);
+            const modelFile = path_1.default.join(modelsDir, `${model_name}.ts`);
+            if (!(await fs_extra_1.default.pathExists(modelFile))) {
+                await fs_extra_1.default.outputFile(modelFile, (0, vtils_1.dedent) `
+              import { ${ModelName}BaseModel } from '@jayfong/x-server'
+
+              export class ${ModelName}Model extends ${ModelName}BaseModel {}
+              
+              export const ${modelName}Model = new ${ModelName}Model()
+            `);
+            }
+        }));
+    }
 }
 exports.TemplateUtil = TemplateUtil;

package/lib/cli/templates/handlers.ts

@@ -1,3 +1,3 @@
-// @index('../../src/handlers/**/*.ts', (f, _) => `export * as __${_.pascal(f.path.replace('handlers', ''))}__ from '${f.path}'`)
+// @index('../../src/handlers/**/*.ts', (f, _) => `export * as __${_.pascal(f.path.replace('/src/handlers/', ''))}__ from '${f.path}'`)
 
 // @endindex

package/lib/cli/templates/package.json

@@ -0,0 +1,3 @@
+{
+  "name": ".x"
+}

package/lib/cli/templates/routes.ts

@@ -2,7 +2,7 @@ import * as handlers from './handlers'
 import { Handler, XServer } from '@jayfong/x-server'
 
 const basePathWithHandlers: Array<[string, Record<string, Handler>]> = [
-  // @index('../../src/handlers/**/*.ts', (f, _) => `['${('/'+_.snake(f.path.replace('handlers', '')).replace(/_/g, '/')+'/').replace(/\/{2,}/g, '/')}', handlers.__${_.pascal(f.path.replace('handlers', ''))}__ as any],`)
+  // @index('../../src/handlers/**/*.ts', (f, _) => `['${('/'+_.snake(f.path.replace('/src/handlers/', '')).replace(/_/g, '/')+'/').replace(/\/{2,}/g, '/')}', handlers.__${_.pascal(f.path.replace('/src/handlers/', ''))}__ as any],`)
   // @endindex
 ]
 

package/lib/core/define_task.js

@@ -5,12 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defineTask = void 0;
 const bull_1 = __importDefault(require("bull"));
-const server_1 = require("./server");
 const x_1 = require("../x");
 async function defineTask(options) {
     const queue = new bull_1.default(options.name, {
         redis: x_1.x.redis.options,
-        prefix: `${server_1.Server.options.name}_task`,
+        prefix: `${x_1.x.appName}_task`,
     });
     queue.process(async (job) => {
         return options.handle(job.data);

package/lib/core/server.d.ts

@@ -9,8 +9,11 @@ export declare class Server {
     close(): Promise<void>;
     private prepareFastify;
     private startFastify;
+    private prepareRoutes;
+    private applyHooks;
     private applyServices;
     private applyPlugins;
     private applyRoutes;
+    private startTasks;
     private applyAutoClose;
 }

package/lib/core/server.js

@@ -29,27 +29,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Server = void 0;
 const fastify_1 = __importDefault(require("fastify"));
 const vtils_1 = require("vtils");
-const dispose_1 = require("../services/dispose");
 const http_method_1 = require("./http_method");
 const x_1 = require("../x");
-// @ts-ignore
-const routes_1 = require(".x/routes");
 class Server {
     constructor(options) {
         this.options = options;
-        this.routes = routes_1.routes;
+        this.routes = [];
         Server.options = options;
     }
     async start() {
         this.applyServices();
         await this.prepareFastify();
         this.applyPlugins();
+        await this.prepareRoutes();
         await this.applyRoutes();
-        // @ts-ignore
-        await Promise.resolve().then(() => __importStar(require('.x/hooks')));
+        await this.applyHooks();
         await this.startFastify();
-        // @ts-ignore
-        await Promise.resolve().then(() => __importStar(require('.x/tasks')));
+        await this.startTasks();
         await this.applyAutoClose();
     }
     async close() {
@@ -70,10 +66,17 @@ class Server {
             port: this.options.port,
         });
     }
+    async prepareRoutes() {
+        // @ts-ignore
+        const { routes } = await Promise.resolve().then(() => __importStar(require('.x/routes')));
+        this.routes = routes;
+    }
+    async applyHooks() {
+        // @ts-ignore
+        await Promise.resolve().then(() => __importStar(require('.x/hooks')));
+    }
     applyServices() {
-        x_1.x.register(new dispose_1.DisposeService({
-            disposeOnExit: true,
-        }), ...(this.options.services || []));
+        x_1.x.register(...(this.options.services || []));
     }
     applyPlugins() {
         const plugins = this.options.plugins || [];
@@ -129,6 +132,10 @@ class Server {
             });
         }
     }
+    async startTasks() {
+        // @ts-ignore
+        await Promise.resolve().then(() => __importStar(require('.x/tasks')));
+    }
     async applyAutoClose() {
         x_1.x.dispose.add(() => this.close());
     }

package/lib/core/types.d.ts

@@ -21,10 +21,6 @@ export declare namespace XServer {
         handler: Handler;
     }
     interface Options {
-        /**
-         * 应用名称
-         */
-        name: string;
         /**
          * 监听主机
          */

package/lib/services/cache.d.ts

@@ -4,9 +4,7 @@ import { MsValue } from 'vtils/date';
 export declare type CacheTTL = MsValue;
 export interface CacheOptions {
     /** 默认过期时间 */
-    defaultTTL: CacheTTL;
-    /** 存储键前缀 */
-    prefix: string;
+    ttl: CacheTTL;
 }
 declare type Data = {
     [K in string]: (...args: any[]) => any;

package/lib/services/cache.js

@@ -11,7 +11,7 @@ class CacheService {
     constructor(options) {
         this.options = options;
         this.serviceName = 'cache';
-        this.prefix = `${options.prefix}:`;
+        this.prefix = `${x_1.x.appName}:`;
     }
     toRedisKey(key) {
         return `${this.prefix}${Array.isArray(key) ? key.join('_') : String(key)}`;
@@ -25,10 +25,10 @@ class CacheService {
      * @returns 返回设置的缓存内容
      */
     async set(key, value, ttl = this.options
-        .defaultTTL) {
+        .ttl) {
         const redisKey = this.toRedisKey(key);
         const redisValue = JSON.stringify(value);
-        const redisTtl = typeof ttl === 'function' ? ttl(value, this.options.defaultTTL) : ttl;
+        const redisTtl = typeof ttl === 'function' ? ttl(value, this.options.ttl) : ttl;
         await x_1.x.redis.set(redisKey, redisValue, 
         // 毫秒
         'PX', (0, date_1.ms)(redisTtl));
@@ -40,7 +40,7 @@ class CacheService {
      * @param value 值
      * @param ttl 存活时间
      */
-    async save(value, ttl = this.options.defaultTTL) {
+    async save(value, ttl = this.options.ttl) {
         const key = `X__${(0, cuid_1.default)()}`;
         await this.set(key, typeof value === 'function' ? await value(key) : value, ttl);
         return key;
@@ -93,7 +93,7 @@ class CacheService {
      * @returns 返回获取到的内容
      */
     async remember(key, action, ttl = this.options
-        .defaultTTL) {
+        .ttl) {
         let value = await this.get(key);
         if (value === null) {
             value = await action();

package/lib/x.d.ts

@@ -1,5 +1,7 @@
 import { BaseService } from './services/base';
+import './services/dispose';
 export interface X {
+    readonly appName: string;
     readonly register: (...services: BaseService[]) => void;
 }
 export declare const x: X;

package/lib/x.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.x = void 0;
+const dispose_1 = require("./services/dispose");
 exports.x = {
+    appName: process.env.APP_NAME,
     register: (...services) => {
         for (const service of services) {
             // @ts-ignore
@@ -9,3 +11,6 @@ exports.x = {
         }
     },
 };
+exports.x.register(new dispose_1.DisposeService({
+    disposeOnExit: true,
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "1.8.0",
+  "version": "1.10.2",
   "license": "ISC",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -38,7 +38,7 @@
     "cuid": "^2.1.8",
     "debug": "^4.3.4",
     "esbuild": "^0.14.36",
-    "esbuild-runner": "^2.2.1",
+    "esbuild-register": "^3.3.2",
     "execa": "^5.1.1",
     "exit-hook": "^2.2.1",
     "fast-xml-parser": "^3.21.1",
@@ -57,7 +57,6 @@
     "supports-color": "^8",
     "svg-captcha": "^1.4.0",
     "ts-morph": "^12.2.0",
-    "tsconfig-paths": "^3.14.1",
     "utf-8-validate": "^5.0.9",
     "vscode-generate-index-standalone": "^1.6.0",
     "vtils": "^4.60.0",