@aomex/common-middleware 3.30.6 → 3.30.8-alpha.62.sha-92b25bb
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/dist/index.d.ts +48 -40
- package/dist/index.js +56 -81
- package/dist/index.js.map +1 -1
- package/package.json +18 -16
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.30.7](https://github.com/aomex/aomex/compare/v3.30.6...v3.30.7) (2026-11-01)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @aomex/common-middleware
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [3.30.6](https://github.com/aomex/aomex/compare/v3.30.5...v3.30.6) (2026-10-19)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @aomex/common-middleware
|
package/dist/index.d.ts
CHANGED
|
@@ -1,50 +1,58 @@
|
|
|
1
|
-
import { NonReadonly } from
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
import { NonReadonly } from "@aomex/internal-tools";
|
|
2
|
+
declare interface MiddlewarePlatform<Deps extends object = object> {
|
|
3
|
+
/**
|
|
4
|
+
* 没有特定上下文的纯中间件,支持所有应用
|
|
5
|
+
*/
|
|
6
|
+
readonly mixin: {
|
|
7
|
+
<Props extends object = object>(fn: (ctx: NonReadonly<Middleware.MergeDeps<Props, Deps>>, next: Next) => any): object extends Deps ? MixinMiddleware<Props> : MixinMiddleware<Props> & {
|
|
8
|
+
_contextType: Middleware.WithDeps<object, Deps>;
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
export declare class MixinMiddleware<Props extends object = object> extends Middleware<Props> {
|
|
13
|
+
protected _mixin_middleware_: 'mixin-middleware';
|
|
13
14
|
}
|
|
14
|
-
|
|
15
|
-
|
|
15
|
+
export declare namespace Middleware {
|
|
16
|
+
type Infer<T> = T extends Middleware<infer R> ? R : T extends ((...args: any[]) => infer Return) ? Awaited<Return> extends Middleware<infer R> ? R : never : never;
|
|
17
|
+
/** 合并依赖;默认 `object` 不参与交叉 */
|
|
18
|
+
type MergeDeps<Current extends object, Next extends object> = object extends Current ? object extends Next ? Current : Next : object extends Next ? Current : Flatten<Current & Next>;
|
|
19
|
+
type Flatten<T extends object> = { [K in keyof T]: T[K]; } & {};
|
|
20
|
+
/** 把 Deps 叠到平台上下文上 */
|
|
21
|
+
type WithDeps<Ctx extends object, Deps extends object> = object extends Deps ? Ctx : object extends Ctx ? Flatten<Deps> : Ctx & Flatten<Deps>;
|
|
22
|
+
type Fn<Ctx = any> = (ctx: Ctx, next: Next) => any;
|
|
23
|
+
type CollectArrayType<T> = T extends Middleware<infer R> ? R : unknown;
|
|
16
24
|
}
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
25
|
+
export interface MiddlewarePlatform<Deps extends object = object> {
|
|
26
|
+
/**
|
|
27
|
+
* 仅用于类型提示:假定上游已挂载对应中间件,不实际执行。
|
|
28
|
+
* 可无限链式调用。
|
|
29
|
+
*/
|
|
30
|
+
readonly dependsOn: <T extends Middleware<any> | ((...args: any[]) => Middleware<any> | Promise<Middleware<any>>)>(_middleware: T) => MiddlewarePlatform<Middleware.MergeDeps<Deps, Middleware.Infer<T>>>;
|
|
21
31
|
}
|
|
22
32
|
/**
|
|
23
33
|
* 中间件基类
|
|
24
34
|
*/
|
|
25
|
-
declare abstract class Middleware<Props extends object = object> {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
35
|
+
export declare abstract class Middleware<Props extends object = object> {
|
|
36
|
+
protected readonly fn: Middleware.Fn;
|
|
37
|
+
_contextType: object;
|
|
38
|
+
protected _props_must_be_used_: Props;
|
|
39
|
+
constructor(fn: Middleware.Fn);
|
|
40
|
+
/**
|
|
41
|
+
* 跳过执行中间件。
|
|
42
|
+
*
|
|
43
|
+
* 可传入布尔值(固定跳过/不跳过),或根据上下文动态判断的函数。
|
|
44
|
+
* 返回的类型未使用Partial,因为skip的设计是在部分场景下才需要触发的。
|
|
45
|
+
*/
|
|
46
|
+
skip(when: boolean | ((ctx: this['_contextType']) => boolean | Promise<boolean>)): MixinMiddleware<Props>;
|
|
47
|
+
/**
|
|
48
|
+
* 注册中间件
|
|
49
|
+
*/
|
|
50
|
+
static register(platform: Exclude<keyof MiddlewarePlatform, 'dependsOn'>, SubMiddleware: new (...args: any[]) => Middleware): void;
|
|
40
51
|
}
|
|
41
|
-
declare const middleware: MiddlewarePlatform;
|
|
42
|
-
|
|
43
|
-
type
|
|
44
|
-
type ComposeFn = (ctx: any, next?: Next) => Promise<void>;
|
|
52
|
+
export declare const middleware: MiddlewarePlatform;
|
|
53
|
+
export type Next = () => Promise<any>;
|
|
54
|
+
export type ComposeFn = (ctx: any, next?: Next) => Promise<void>;
|
|
45
55
|
/**
|
|
46
56
|
* 组合中间件
|
|
47
57
|
*/
|
|
48
|
-
declare const compose: (middlewareList: Middleware[]) => ComposeFn;
|
|
49
|
-
|
|
50
|
-
export { type ComposeFn, Middleware, type MiddlewarePlatform, MixinMiddleware, type Next, compose, middleware };
|
|
58
|
+
export declare const compose: (middlewareList: Middleware[]) => ComposeFn;
|
package/dist/index.js
CHANGED
|
@@ -1,93 +1,68 @@
|
|
|
1
|
-
|
|
2
|
-
import { I18n as I18n3 } from "@aomex/internal-tools";
|
|
3
|
-
|
|
1
|
+
import { I18n, createI18n } from "@aomex/internal-tools";
|
|
4
2
|
// src/i18n/locales/zh-cn.ts
|
|
5
|
-
|
|
6
|
-
var zh = I18n.define({
|
|
7
|
-
middleware: {
|
|
8
|
-
call_next_multiple: "\u591A\u6B21\u6267\u884C\u4E2D\u95F4\u4EF6next()\u51FD\u6570"
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
3
|
+
const zh = I18n.define({ middleware: { call_next_multiple: "next() 被调用了多次" } });
|
|
12
4
|
// src/i18n/locales/en-us.ts
|
|
13
|
-
|
|
14
|
-
var en = I18n2.satisfies(zh).define({
|
|
15
|
-
middleware: {
|
|
16
|
-
call_next_multiple: "call next() multiple times"
|
|
17
|
-
}
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
// src/i18n/locales/index.ts
|
|
21
|
-
var locales = {
|
|
22
|
-
zh_CN: zh,
|
|
23
|
-
en_US: en
|
|
24
|
-
};
|
|
25
|
-
|
|
5
|
+
const en = I18n.satisfies(zh).define({ middleware: { call_next_multiple: "next() was called more than once" } });
|
|
26
6
|
// src/i18n/index.ts
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
7
|
+
const i18n = createI18n({
|
|
8
|
+
zh,
|
|
9
|
+
en,
|
|
10
|
+
load: (file) => import(new URL(`./locales/${file}.js`, import.meta.url).href)
|
|
30
11
|
});
|
|
31
|
-
|
|
32
12
|
// src/compose.ts
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
return dispatch(0);
|
|
51
|
-
};
|
|
13
|
+
const noop = () => {};
|
|
14
|
+
/**
|
|
15
|
+
* 组合中间件
|
|
16
|
+
*/
|
|
17
|
+
const compose = (middlewareList) => {
|
|
18
|
+
const total = middlewareList.length;
|
|
19
|
+
const fns = middlewareList.map((md) => md["fn"]);
|
|
20
|
+
return (ctx, next) => {
|
|
21
|
+
let lastIndex = -1;
|
|
22
|
+
const dispatch = async (i) => {
|
|
23
|
+
if (i <= lastIndex) throw new Error(i18n.t("middleware.call_next_multiple"));
|
|
24
|
+
const finished = (lastIndex = i) === total;
|
|
25
|
+
const fn = finished ? next : fns[lastIndex];
|
|
26
|
+
if (fn) await fn(ctx, finished ? noop : dispatch.bind(null, i + 1));
|
|
27
|
+
};
|
|
28
|
+
return dispatch(0);
|
|
29
|
+
};
|
|
52
30
|
};
|
|
53
|
-
|
|
54
31
|
// src/middleware.ts
|
|
32
|
+
/**
|
|
33
|
+
* 中间件基类
|
|
34
|
+
*/
|
|
55
35
|
var Middleware = class {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
}
|
|
36
|
+
fn;
|
|
37
|
+
constructor(fn) {
|
|
38
|
+
this.fn = fn;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* 跳过执行中间件。
|
|
42
|
+
*
|
|
43
|
+
* 可传入布尔值(固定跳过/不跳过),或根据上下文动态判断的函数。
|
|
44
|
+
* 返回的类型未使用Partial,因为skip的设计是在部分场景下才需要触发的。
|
|
45
|
+
*/
|
|
46
|
+
skip(when) {
|
|
47
|
+
return middleware.mixin(async (ctx, next) => {
|
|
48
|
+
return (typeof when === "boolean" ? when : await when(ctx)) ? next() : this.fn(ctx, next);
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* 注册中间件
|
|
53
|
+
*/
|
|
54
|
+
static register(platform, SubMiddleware) {
|
|
55
|
+
Object.defineProperty(middleware, platform, { get() {
|
|
56
|
+
return (...args) => new SubMiddleware(...args);
|
|
57
|
+
} });
|
|
58
|
+
}
|
|
80
59
|
};
|
|
81
|
-
|
|
82
|
-
|
|
60
|
+
const middleware = { dependsOn() {
|
|
61
|
+
return middleware;
|
|
62
|
+
} };
|
|
83
63
|
// src/mixin-middleware.ts
|
|
84
|
-
var MixinMiddleware = class extends Middleware {
|
|
85
|
-
};
|
|
64
|
+
var MixinMiddleware = class extends Middleware {};
|
|
86
65
|
Middleware.register("mixin", MixinMiddleware);
|
|
87
|
-
export {
|
|
88
|
-
|
|
89
|
-
MixinMiddleware,
|
|
90
|
-
compose,
|
|
91
|
-
middleware
|
|
92
|
-
};
|
|
66
|
+
export { Middleware, MixinMiddleware, compose, middleware };
|
|
67
|
+
|
|
93
68
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/i18n/locales/zh-cn.ts","../src/i18n/locales/en-us.ts","../src/i18n/index.ts","../src/compose.ts","../src/middleware.ts","../src/mixin-middleware.ts"],"sourcesContent":["import { I18n } from '@aomex/internal-tools';\n\nexport const zh = I18n.define({\n middleware: {\n call_next_multiple: 'next() 被调用了多次',\n },\n});\n","import { I18n } from '@aomex/internal-tools';\nimport { zh } from './zh-cn';\n\nexport const en = I18n.satisfies(zh).define({\n middleware: {\n call_next_multiple: 'next() was called more than once',\n },\n});\n","import { createI18n } from '@aomex/internal-tools';\nimport { zh } from './locales/zh-cn';\nimport { en } from './locales/en-us';\n\nexport const i18n = createI18n({\n zh,\n en,\n load: (file) => import(new URL(`./locales/${file}.js`, import.meta.url).href),\n});\n","import { i18n } from './i18n';\nimport type { Middleware } from './middleware';\n\nexport type Next = () => Promise<any>;\nexport type ComposeFn = (ctx: any, next?: Next) => Promise<void>;\nconst noop = (): any => {};\n\n/**\n * 组合中间件\n */\nexport const compose = (middlewareList: Middleware[]): ComposeFn => {\n const total = middlewareList.length;\n const fns = middlewareList.map((md) => md['fn']);\n\n return (ctx, next) => {\n let lastIndex = -1;\n const dispatch = async (i: number): Promise<void> => {\n if (i <= lastIndex) {\n throw new Error(i18n.t('middleware.call_next_multiple'));\n }\n const finished = (lastIndex = i) === total;\n const fn = finished ? next : fns[lastIndex];\n if (fn) {\n await fn(ctx, finished ? noop : dispatch.bind(null, i + 1));\n }\n };\n return dispatch(0);\n };\n};\n","import type { Next } from './compose';\nimport type { MixinMiddleware } from './mixin-middleware';\n\nexport declare namespace Middleware {\n export type Infer<T> =\n T extends Middleware<infer R>\n ? R\n : T extends (...args: any[]) => infer Return\n ? Awaited<Return> extends Middleware<infer R>\n ? R\n : never\n : never;\n\n /** 合并依赖;默认 `object` 不参与交叉 */\n export type MergeDeps<\n Current extends object,\n Next extends object,\n > = object extends Current\n ? object extends Next\n ? Current\n : Next\n : object extends Next\n ? Current\n : Flatten<Current & Next>;\n\n export type Flatten<T extends object> = { [K in keyof T]: T[K] } & {};\n\n /** 把 Deps 叠到平台上下文上 */\n export type WithDeps<Ctx extends object, Deps extends object> = object extends Deps\n ? Ctx\n : object extends Ctx\n ? Flatten<Deps>\n : Ctx & Flatten<Deps>;\n\n export type Fn<Ctx = any> = (ctx: Ctx, next: Next) => any;\n\n export type CollectArrayType<T> = T extends Middleware<infer R> ? R : unknown;\n}\n\nexport interface MiddlewarePlatform<Deps extends object = object> {\n /**\n * 仅用于类型提示:假定上游已挂载对应中间件,不实际执行。\n * 可无限链式调用。\n */\n readonly dependsOn: <\n T extends\n Middleware<any> | ((...args: any[]) => Middleware<any> | Promise<Middleware<any>>),\n >(\n _middleware: T,\n ) => MiddlewarePlatform<Middleware.MergeDeps<Deps, Middleware.Infer<T>>>;\n}\n\n/**\n * 中间件基类\n */\nexport abstract class Middleware<Props extends object = object> {\n declare public _contextType: object;\n\n declare protected _props_must_be_used_: Props;\n\n constructor(protected readonly fn: Middleware.Fn) {}\n\n /**\n * 跳过执行中间件。\n *\n * 可传入布尔值(固定跳过/不跳过),或根据上下文动态判断的函数。\n * 返回的类型未使用Partial,因为skip的设计是在部分场景下才需要触发的。\n */\n public skip(\n when: boolean | ((ctx: this['_contextType']) => boolean | Promise<boolean>),\n ): MixinMiddleware<Props> {\n return middleware.mixin(async (ctx, next) => {\n const skipped = typeof when === 'boolean' ? when : await when(ctx);\n return skipped ? next() : this.fn(ctx, next);\n });\n }\n\n /**\n * 注册中间件\n */\n static register(\n platform: Exclude<keyof MiddlewarePlatform, 'dependsOn'>,\n SubMiddleware: new (...args: any[]) => Middleware,\n ) {\n Object.defineProperty(middleware, platform, {\n get() {\n return (...args: any[]) => new SubMiddleware(...args);\n },\n });\n }\n}\n\nexport const middleware: MiddlewarePlatform = {\n dependsOn() {\n return middleware;\n },\n} as any;\n","import type { NonReadonly } from '@aomex/internal-tools';\nimport type { Next } from './compose';\nimport { Middleware } from './middleware';\n\ndeclare module './middleware' {\n export interface MiddlewarePlatform<Deps extends object = object> {\n /**\n * 没有特定上下文的纯中间件,支持所有应用\n */\n readonly mixin: {\n <Props extends object = object>(\n fn: (ctx: NonReadonly<Middleware.MergeDeps<Props, Deps>>, next: Next) => any,\n ): object extends Deps\n ? MixinMiddleware<Props>\n : MixinMiddleware<Props> & {\n _contextType: Middleware.WithDeps<object, Deps>;\n };\n };\n }\n}\n\nexport class MixinMiddleware<Props extends object = object> extends Middleware<Props> {\n declare protected _mixin_middleware_: 'mixin-middleware';\n}\n\nMiddleware.register('mixin', MixinMiddleware);\n"],"mappings":";;AAEA,MAAa,KAAK,KAAK,OAAO,EAC5B,YAAY,EACV,oBAAoB,gBACtB,EACF,CAAC;;ACHD,MAAa,KAAK,KAAK,UAAU,EAAE,CAAC,CAAC,OAAO,EAC1C,YAAY,EACV,oBAAoB,mCACtB,EACF,CAAC;;ACHD,MAAa,OAAO,WAAW;CAC7B;CACA;CACA,OAAO,SAAS,OAAO,IAAI,IAAI,aAAa,KAAK,MAAM,YAAY,GAAG,CAAC,CAAC;AAC1E,CAAC;;ACHD,MAAM,aAAkB,CAAC;;;;AAKzB,MAAa,WAAW,mBAA4C;CAClE,MAAM,QAAQ,eAAe;CAC7B,MAAM,MAAM,eAAe,KAAK,OAAO,GAAG,KAAK;CAE/C,QAAQ,KAAK,SAAS;EACpB,IAAI,YAAY;EAChB,MAAM,WAAW,OAAO,MAA6B;GACnD,IAAI,KAAK,WACP,MAAM,IAAI,MAAM,KAAK,EAAE,+BAA+B,CAAC;GAEzD,MAAM,YAAY,YAAY,OAAO;GACrC,MAAM,KAAK,WAAW,OAAO,IAAI;GACjC,IAAI,IACF,MAAM,GAAG,KAAK,WAAW,OAAO,SAAS,KAAK,MAAM,IAAI,CAAC,CAAC;EAE9D;EACA,OAAO,SAAS,CAAC;CACnB;AACF;;;;;AC2BA,IAAsB,aAAtB,MAAgE;CAK/B;CAA/B,YAAY,IAAsC;EAAnB,KAAA,KAAA;CAAoB;;;;;;;CAQnD,KACE,MACwB;EACxB,OAAO,WAAW,MAAM,OAAO,KAAK,SAAS;GAE3C,QADgB,OAAO,SAAS,YAAY,OAAO,MAAM,KAAK,GAAG,KAChD,KAAK,IAAI,KAAK,GAAG,KAAK,IAAI;EAC7C,CAAC;CACH;;;;CAKA,OAAO,SACL,UACA,eACA;EACA,OAAO,eAAe,YAAY,UAAU,EAC1C,MAAM;GACJ,QAAQ,GAAG,SAAgB,IAAI,cAAc,GAAG,IAAI;EACtD,EACF,CAAC;CACH;AACF;AAEA,MAAa,aAAiC,EAC5C,YAAY;CACV,OAAO;AACT,EACF;;AC3EA,IAAa,kBAAb,cAAoE,WAAkB,CAEtF;AAEA,WAAW,SAAS,SAAS,eAAe"}
|
package/package.json
CHANGED
|
@@ -1,17 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/common-middleware",
|
|
3
|
-
"version": "3.30.
|
|
3
|
+
"version": "3.30.8-alpha.62.sha-92b25bb",
|
|
4
4
|
"description": "aomex中间件",
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
"exports": {
|
|
8
|
-
".": {
|
|
9
|
-
"types": "./dist/index.d.ts",
|
|
10
|
-
"import": "./dist/index.js"
|
|
11
|
-
},
|
|
12
|
-
"./package.json": "./package.json"
|
|
5
|
+
"scripts": {
|
|
6
|
+
"prepublishOnly": "tsdown && node scripts/post-build.mjs"
|
|
13
7
|
},
|
|
8
|
+
"type": "module",
|
|
9
|
+
"types": "src/index.ts",
|
|
10
|
+
"exports": "./src/index.ts",
|
|
14
11
|
"publishConfig": {
|
|
12
|
+
"types": "dist/index.d.ts",
|
|
13
|
+
"exports": {
|
|
14
|
+
".": {
|
|
15
|
+
"types": "./dist/index.d.ts",
|
|
16
|
+
"import": "./dist/index.js"
|
|
17
|
+
},
|
|
18
|
+
"./package.json": "./package.json"
|
|
19
|
+
},
|
|
15
20
|
"access": "public"
|
|
16
21
|
},
|
|
17
22
|
"files": [
|
|
@@ -21,14 +26,11 @@
|
|
|
21
26
|
"README.md",
|
|
22
27
|
"CHANGELOG.md"
|
|
23
28
|
],
|
|
24
|
-
"repository":
|
|
25
|
-
"type": "git",
|
|
26
|
-
"url": "git@github.com:aomex/aomex.git"
|
|
27
|
-
},
|
|
29
|
+
"repository": "git@github.com:aomex/aomex.git",
|
|
28
30
|
"homepage": "https://aomex.js.org",
|
|
29
31
|
"license": "MIT",
|
|
30
32
|
"dependencies": {
|
|
31
|
-
"@aomex/internal-tools": "3.30.
|
|
33
|
+
"@aomex/internal-tools": "3.30.8-alpha.62.sha-92b25bb"
|
|
32
34
|
},
|
|
33
|
-
"
|
|
34
|
-
}
|
|
35
|
+
"gitHead": "92b25bbcd6c3ae28160316117a74c88619b5bc8d"
|
|
36
|
+
}
|