Skip to content

K
koishi-decorators
Commit 4fab54c2 authored by nanahira's avatar nanahira
Browse files
Options

bump and add CallbackLayer

parent 81750222
Hide whitespace changes
Inline Side-by-side
Showing with 99 additions and 24 deletions
package-lock.json
View file @ 4fab54c2
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
"typescript": "^4.6.4" "typescript": "^4.6.4"
}, },
"peerDependencies": { "peerDependencies": {
"koishi": "^4.7.2" "koishi": "^4.7.4"
} }
}, },
"node_modules/@babel/code-frame": { "node_modules/@babel/code-frame": {
...@@ -999,13 +999,13 @@ ...@@ -999,13 +999,13 @@
} }
}, },
"node_modules/@koishijs/core": { "node_modules/@koishijs/core": {
"version": "4.7.2", "version": "4.7.4",
"resolved": "https://registry.npmjs.org/@koishijs/core/-/core-4.7.2.tgz", "resolved": "https://registry.npmjs.org/@koishijs/core/-/core-4.7.4.tgz",
"integrity": "sha512-yO5Pyki1RV+MSqR1IzX02z6wLlJRej7RSH7zW4/+nd5r1fimtDaODiQz/F7lGfcuVthIPDg2aPxJXkl8eLCoSw==", "integrity": "sha512-S4pPaO05WC0htkQVcTMTluBZv4g8sEEBJ2ItHN2zJA8syet3iKJidT+s2gYt8d2rBo0Ndlvo1gBLGLNl/Zc9yg==",
"peer": true, "peer": true,
"dependencies": { "dependencies": {
"@koishijs/utils": "^5.4.5", "@koishijs/utils": "^5.4.5",
"cordis": "^1.2.2", "cordis": "^1.3.3",
"fastest-levenshtein": "^1.0.12", "fastest-levenshtein": "^1.0.12",
"minato": "^1.1.0" "minato": "^1.1.0"
}, },
...@@ -2279,9 +2279,9 @@ ...@@ -2279,9 +2279,9 @@
"peer": true "peer": true
}, },
"node_modules/cordis": { "node_modules/cordis": {
"version": "1.2.2", "version": "1.3.3",
"resolved": "https://registry.npmjs.org/cordis/-/cordis-1.2.2.tgz", "resolved": "https://registry.npmjs.org/cordis/-/cordis-1.3.3.tgz",
"integrity": "sha512-R6RhHuBu6be5DGXBkIGyw3W/yPBPqr69KBVEGVgBY38DzMBIXilmsfAdVdIIEe3G0vlnn5rtAgsMg2yGwRpkiQ==", "integrity": "sha512-mpyBWAEVYX8/YHoGWIqaOjrOk6DmtrOWZfsBSinNR+nDBlB39Ks6aC1B5oZ7AdnVoRE2ZYBCGecoHrlxcRxd6w==",
"peer": true, "peer": true,
"dependencies": { "dependencies": {
"cosmokit": "^1.1.2" "cosmokit": "^1.1.2"
...@@ -4763,13 +4763,13 @@ ...@@ -4763,13 +4763,13 @@
} }
}, },
"node_modules/koishi": { "node_modules/koishi": {
"version": "4.7.2", "version": "4.7.4",
"resolved": "https://registry.npmjs.org/koishi/-/koishi-4.7.2.tgz", "resolved": "https://registry.npmjs.org/koishi/-/koishi-4.7.4.tgz",
"integrity": "sha512-oH1yIGX8skfPO4WcLPpnNqt+qzETVux7OIAK9jkMQxHLJv1fq1/OqsLS0wTvpTJ8qFZLt49lZ3gbLujga43RPA==", "integrity": "sha512-VVHf3TyFsTuKrB8IZffxwmwiGx+zyhDo+DNNEFQjvomgqFdGEceAnLxNIf10K48aB1CDmkmi37b6uaURi4Z1Hw==",
"peer": true, "peer": true,
"dependencies": { "dependencies": {
"@koa/router": "^10.1.1", "@koa/router": "^10.1.1",
"@koishijs/core": "^4.7.2", "@koishijs/core": "^4.7.4",
"@koishijs/utils": "^5.4.5", "@koishijs/utils": "^5.4.5",
"@types/koa": "*", "@types/koa": "*",
"@types/koa__router": "*", "@types/koa__router": "*",
...@@ -7648,13 +7648,13 @@ ...@@ -7648,13 +7648,13 @@
} }
}, },
"@koishijs/core": { "@koishijs/core": {
"version": "4.7.2", "version": "4.7.4",
"resolved": "https://registry.npmjs.org/@koishijs/core/-/core-4.7.2.tgz", "resolved": "https://registry.npmjs.org/@koishijs/core/-/core-4.7.4.tgz",
"integrity": "sha512-yO5Pyki1RV+MSqR1IzX02z6wLlJRej7RSH7zW4/+nd5r1fimtDaODiQz/F7lGfcuVthIPDg2aPxJXkl8eLCoSw==", "integrity": "sha512-S4pPaO05WC0htkQVcTMTluBZv4g8sEEBJ2ItHN2zJA8syet3iKJidT+s2gYt8d2rBo0Ndlvo1gBLGLNl/Zc9yg==",
"peer": true, "peer": true,
"requires": { "requires": {
"@koishijs/utils": "^5.4.5", "@koishijs/utils": "^5.4.5",
"cordis": "^1.2.2", "cordis": "^1.3.3",
"fastest-levenshtein": "^1.0.12", "fastest-levenshtein": "^1.0.12",
"minato": "^1.1.0" "minato": "^1.1.0"
} }
...@@ -8670,9 +8670,9 @@ ...@@ -8670,9 +8670,9 @@
"peer": true "peer": true
}, },
"cordis": { "cordis": {
"version": "1.2.2", "version": "1.3.3",
"resolved": "https://registry.npmjs.org/cordis/-/cordis-1.2.2.tgz", "resolved": "https://registry.npmjs.org/cordis/-/cordis-1.3.3.tgz",
"integrity": "sha512-R6RhHuBu6be5DGXBkIGyw3W/yPBPqr69KBVEGVgBY38DzMBIXilmsfAdVdIIEe3G0vlnn5rtAgsMg2yGwRpkiQ==", "integrity": "sha512-mpyBWAEVYX8/YHoGWIqaOjrOk6DmtrOWZfsBSinNR+nDBlB39Ks6aC1B5oZ7AdnVoRE2ZYBCGecoHrlxcRxd6w==",
"peer": true, "peer": true,
"requires": { "requires": {
"cosmokit": "^1.1.2" "cosmokit": "^1.1.2"
...@@ -10547,13 +10547,13 @@ ...@@ -10547,13 +10547,13 @@
} }
}, },
"koishi": { "koishi": {
"version": "4.7.2", "version": "4.7.4",
"resolved": "https://registry.npmjs.org/koishi/-/koishi-4.7.2.tgz", "resolved": "https://registry.npmjs.org/koishi/-/koishi-4.7.4.tgz",
"integrity": "sha512-oH1yIGX8skfPO4WcLPpnNqt+qzETVux7OIAK9jkMQxHLJv1fq1/OqsLS0wTvpTJ8qFZLt49lZ3gbLujga43RPA==", "integrity": "sha512-VVHf3TyFsTuKrB8IZffxwmwiGx+zyhDo+DNNEFQjvomgqFdGEceAnLxNIf10K48aB1CDmkmi37b6uaURi4Z1Hw==",
"peer": true, "peer": true,
"requires": { "requires": {
"@koa/router": "^10.1.1", "@koa/router": "^10.1.1",
"@koishijs/core": "^4.7.2", "@koishijs/core": "^4.7.4",
"@koishijs/utils": "^5.4.5", "@koishijs/utils": "^5.4.5",
"@types/koa": "*", "@types/koa": "*",
"@types/koa__router": "*", "@types/koa__router": "*",
......
package.json
View file @ 4fab54c2
...@@ -66,6 +66,6 @@ ...@@ -66,6 +66,6 @@
"typed-reflector": "^1.0.10" "typed-reflector": "^1.0.10"
}, },
"peerDependencies": { "peerDependencies": {
"koishi": "^4.7.2" "koishi": "^4.7.4"
} }
} }
src/decorators/decorators.ts
View file @ 4fab54c2
...@@ -4,6 +4,7 @@ import { ...@@ -4,6 +4,7 @@ import {
CommandDefinitionFun, CommandDefinitionFun,
CommandLocaleDef, CommandLocaleDef,
CommandOptionConfigWithDescription, CommandOptionConfigWithDescription,
ContextCallbackLayer,
EventName, EventName,
KoishiCommandDefinition, KoishiCommandDefinition,
KoishiCommandPutDef, KoishiCommandPutDef,
...@@ -272,3 +273,8 @@ export function DefineLocale( ...@@ -272,3 +273,8 @@ export function DefineLocale(
ctx.i18n.define(r(locale), ...r(args)), ctx.i18n.define(r(locale), ...r(args)),
); );
} }
export const CallbackLayer = (
layer: ContextCallbackLayer,
): ClassDecorator & MethodDecorator =>
Metadata.append('KoishiContextLayers', layer);
src/def/constants.ts
View file @ 4fab54c2
// metadatas // metadatas
import { import {
CommandDefinitionFun, CommandDefinitionFun,
ContextCallbackLayer,
MappingStruct, MappingStruct,
OnContextFunction, OnContextFunction,
TopLevelActionDef, TopLevelActionDef,
...@@ -21,6 +22,7 @@ export interface MetadataArrayMap { ...@@ -21,6 +22,7 @@ export interface MetadataArrayMap {
KoishiDoRegisterKeys: string; KoishiDoRegisterKeys: string;
KoishiTopLevelAction: TopLevelActionDef; KoishiTopLevelAction: TopLevelActionDef;
KoishiPutClassFieldKeys: string; KoishiPutClassFieldKeys: string;
KoishiContextLayers: ContextCallbackLayer;
} }
export interface MetadataMap { export interface MetadataMap {
......
src/def/interfaces.ts
View file @ 4fab54c2
...@@ -203,3 +203,8 @@ export type PickEventFunction<M, K extends keyof M> = M[K] extends ( ...@@ -203,3 +203,8 @@ export type PickEventFunction<M, K extends keyof M> = M[K] extends (
) => any ) => any
? (...args: FunctionParam<M[K]>) => Awaitable<FunctionReturn<M[K]>> ? (...args: FunctionParam<M[K]>) => Awaitable<FunctionReturn<M[K]>>
: M[K]; : M[K];
export type ContextCallbackLayer<T = any> = (
ctx: Context,
cb: ContextFunction<void>,
) => T;
src/register.ts
View file @ 4fab54c2
import { import {
ContextCallbackLayer,
ContextFunction,
KoishiDoRegister, KoishiDoRegister,
KoishiDoRegisterKeys, KoishiDoRegisterKeys,
KoishiOnContextScope, KoishiOnContextScope,
...@@ -76,6 +78,42 @@ export class Registrar<T = any> { ...@@ -76,6 +78,42 @@ export class Registrar<T = any> {
return { ...data, key: key as keyof T & string, result }; return { ...data, key: key as keyof T & string, result };
} }
private runLayersWith<R>(
ctx: Context,
cb: ContextFunction<R>,
layers: ContextCallbackLayer[],
): Promise<Awaited<R>> {
const rest = [...layers];
const layer = rest.pop();
return new Promise<any>((resolve) => {
layer(ctx, async (nextCtx) => {
let result: R;
if (!rest.length) {
result = await cb(nextCtx);
} else {
result = await this.runLayersWith(nextCtx, cb, rest);
}
resolve(result);
});
});
}
runLayers<R>(ctx: Context, cb: ContextFunction<R>, key?: keyof T) {
let layers = reflector.getArray(
'KoishiContextLayers',
this.obj,
key as string,
);
if (!key && this.alternativeObject) {
const altLayers = reflector.getArray(
'KoishiContextLayers',
this.alternativeObject,
);
layers = layers.concat(altLayers);
}
return this.runLayersWith(ctx, cb, layers);
}
registerAll( registerAll(
ctx: Context, ctx: Context,
autoScope = false, autoScope = false,
......
tests/register.spec.ts
View file @ 4fab54c2
import { import {
CallbackLayer,
CommandUsage, CommandUsage,
PutArg, PutArg,
PutObject, PutObject,
...@@ -60,6 +61,19 @@ class MyClass { ...@@ -60,6 +61,19 @@ class MyClass {
) { ) {
return `I have ${count} ${name}.`; return `I have ${count} ${name}.`;
} }
@CallbackLayer((ctx, cb) => {
ctx['foo'] = 1;
cb(ctx);
})
@CallbackLayer((ctx, cb) => {
ctx['bar'] = 2;
cb(ctx);
})
@UseCommand('underwear')
async unUnderwear(@PutArg(0) count: number) {
return `I have ${count} underwears.`;
}
} }
const registrar = new Registrar(new MyClass()); const registrar = new Registrar(new MyClass());
...@@ -132,4 +146,14 @@ describe('Register', () => { ...@@ -132,4 +146,14 @@ describe('Register', () => {
'I have 7 socks.', 'I have 7 socks.',
); );
}); });
it('should work with layers', () => {
registrar.runLayers(
app,
(ctx) => registrar.register(app, 'unUnderwear'),
'unUnderwear',
);
expect(app['foo']).toBe(1);
expect(app['bar']).toBe(2);
});
}); });
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment