summaryrefslogtreecommitdiff
path: root/packages/frontend/src
diff options
context:
space:
mode:
authorKokiSakano <61353435+KokiSakano@users.noreply.github.com>2023-03-01 15:19:20 +0900
committerGitHub <noreply@github.com>2023-03-01 15:19:20 +0900
commit830fabef12c6ef91eaaee3ad7bc73a5c110ff939 (patch)
tree06164dc0b4ee661e4e9f7dba2b312d808a09463e /packages/frontend/src
parentenhance(client): Renote した時の表示をリップルエフェクトと t... (diff)
downloadsharkey-830fabef12c6ef91eaaee3ad7bc73a5c110ff939.tar.gz
sharkey-830fabef12c6ef91eaaee3ad7bc73a5c110ff939.tar.bz2
sharkey-830fabef12c6ef91eaaee3ad7bc73a5c110ff939.zip
refactor: plugin.tsの型を修正する (#10027)
* refactor:plugin内のすべての関数にreturn typeを設定 * fix:pluginContextsから取得できない場合は早期リターンする * fix:valueがstring以外の時は早期リターンする * fix:valueが取得できる時以外は早期リターンする * fix:pluginに型をつける * fix:絞り込みをassertStringに変更 * fix:修正漏れ * fix:valToJsからvalueを取得するように変更
Diffstat (limited to 'packages/frontend/src')
-rw-r--r--packages/frontend/src/plugin.ts70
-rw-r--r--packages/frontend/src/store.ts5
2 files changed, 54 insertions, 21 deletions
diff --git a/packages/frontend/src/plugin.ts b/packages/frontend/src/plugin.ts
index 17eb99be22..a1a36480fd 100644
--- a/packages/frontend/src/plugin.ts
+++ b/packages/frontend/src/plugin.ts
@@ -1,12 +1,12 @@
import { Interpreter, Parser, utils, values } from '@syuilo/aiscript';
import { createAiScriptEnv } from '@/scripts/aiscript/api';
import { inputText } from '@/os';
-import { noteActions, notePostInterruptors, noteViewInterruptors, postFormActions, userActions } from '@/store';
+import { Plugin, noteActions, notePostInterruptors, noteViewInterruptors, postFormActions, userActions } from '@/store';
const parser = new Parser();
const pluginContexts = new Map<string, Interpreter>();
-export function install(plugin) {
+export function install(plugin: Plugin): void {
// 後方互換性のため
if (plugin.src == null) return;
console.info('Plugin installed:', plugin.name, 'v' + plugin.version);
@@ -15,7 +15,7 @@ export function install(plugin) {
plugin: plugin,
storageKey: 'plugins:' + plugin.id,
}), {
- in: (q) => {
+ in: (q): Promise<string> => {
return new Promise(ok => {
inputText({
title: q,
@@ -28,10 +28,10 @@ export function install(plugin) {
});
});
},
- out: (value) => {
+ out: (value): void => {
console.log(value);
},
- log: (type, params) => {
+ log: (): void => {
},
});
@@ -40,9 +40,9 @@ export function install(plugin) {
aiscript.exec(parser.parse(plugin.src));
}
-function createPluginEnv(opts) {
- const config = new Map();
- for (const [k, v] of Object.entries(opts.plugin.config || {})) {
+function createPluginEnv(opts: { plugin: Plugin; storageKey: string }): Record<string, values.Value> {
+ const config = new Map<string, values.Value>();
+ for (const [k, v] of Object.entries(opts.plugin.config ?? {})) {
config.set(k, utils.jsToVal(typeof opts.plugin.configData[k] !== 'undefined' ? opts.plugin.configData[k] : v.default));
}
@@ -50,22 +50,28 @@ function createPluginEnv(opts) {
...createAiScriptEnv({ ...opts, token: opts.plugin.token }),
//#region Deprecated
'Mk:register_post_form_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerPostFormAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
'Mk:register_user_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerUserAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
'Mk:register_note_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerNoteAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
//#endregion
'Plugin:register_post_form_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerPostFormAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
'Plugin:register_user_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerUserAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
'Plugin:register_note_action': values.FN_NATIVE(([title, handler]) => {
+ utils.assertString(title);
registerNoteAction({ pluginId: opts.plugin.id, title: title.value, handler });
}),
'Plugin:register_note_view_interruptor': values.FN_NATIVE(([handler]) => {
@@ -75,54 +81,78 @@ function createPluginEnv(opts) {
registerNotePostInterruptor({ pluginId: opts.plugin.id, handler });
}),
'Plugin:open_url': values.FN_NATIVE(([url]) => {
+ utils.assertString(url);
window.open(url.value, '_blank');
}),
'Plugin:config': values.OBJ(config),
};
}
-function initPlugin({ plugin, aiscript }) {
+function initPlugin({ plugin, aiscript }): void {
pluginContexts.set(plugin.id, aiscript);
}
-function registerPostFormAction({ pluginId, title, handler }) {
+function registerPostFormAction({ pluginId, title, handler }): void {
postFormActions.push({
title, handler: (form, update) => {
- pluginContexts.get(pluginId).execFn(handler, [utils.jsToVal(form), values.FN_NATIVE(([key, value]) => {
- update(key.value, value.value);
+ const pluginContext = pluginContexts.get(pluginId);
+ if (!pluginContext) {
+ return;
+ }
+ pluginContext.execFn(handler, [utils.jsToVal(form), values.FN_NATIVE(([key, value]) => {
+ if (!key || !value) {
+ return;
+ }
+ update(utils.valToJs(key), utils.valToJs(value));
})]);
},
});
}
-function registerUserAction({ pluginId, title, handler }) {
+function registerUserAction({ pluginId, title, handler }): void {
userActions.push({
title, handler: (user) => {
- pluginContexts.get(pluginId).execFn(handler, [utils.jsToVal(user)]);
+ const pluginContext = pluginContexts.get(pluginId);
+ if (!pluginContext) {
+ return;
+ }
+ pluginContext.execFn(handler, [utils.jsToVal(user)]);
},
});
}
-function registerNoteAction({ pluginId, title, handler }) {
+function registerNoteAction({ pluginId, title, handler }): void {
noteActions.push({
title, handler: (note) => {
- pluginContexts.get(pluginId).execFn(handler, [utils.jsToVal(note)]);
+ const pluginContext = pluginContexts.get(pluginId);
+ if (!pluginContext) {
+ return;
+ }
+ pluginContext.execFn(handler, [utils.jsToVal(note)]);
},
});
}
-function registerNoteViewInterruptor({ pluginId, handler }) {
+function registerNoteViewInterruptor({ pluginId, handler }): void {
noteViewInterruptors.push({
handler: async (note) => {
- return utils.valToJs(await pluginContexts.get(pluginId).execFn(handler, [utils.jsToVal(note)]));
+ const pluginContext = pluginContexts.get(pluginId);
+ if (!pluginContext) {
+ return;
+ }
+ return utils.valToJs(await pluginContext.execFn(handler, [utils.jsToVal(note)]));
},
});
}
-function registerNotePostInterruptor({ pluginId, handler }) {
+function registerNotePostInterruptor({ pluginId, handler }): void {
notePostInterruptors.push({
handler: async (note) => {
- return utils.valToJs(await pluginContexts.get(pluginId).execFn(handler, [utils.jsToVal(note)]));
+ const pluginContext = pluginContexts.get(pluginId);
+ if (!pluginContext) {
+ return;
+ }
+ return utils.valToJs(await pluginContext.execFn(handler, [utils.jsToVal(note)]));
},
});
}
diff --git a/packages/frontend/src/store.ts b/packages/frontend/src/store.ts
index fd2f2523c9..14226468eb 100644
--- a/packages/frontend/src/store.ts
+++ b/packages/frontend/src/store.ts
@@ -287,12 +287,15 @@ export const defaultStore = markRaw(new Storage('base', {
const PREFIX = 'miux:' as const;
-type Plugin = {
+export type Plugin = {
id: string;
name: string;
active: boolean;
+ config?: Record<string, { default: any }>;
configData: Record<string, any>;
token: string;
+ src: string | null;
+ version: string;
ast: any[];
};