Mk:apiの第三引数にnullを使いたい(トークン無しでエンドポイントを叩けるようにしてほしい)

[Sayamame-beans]

Summary

Mk:api()では第一引数にURLそのものを渡すことが出来るため、リモートのエンドポイントも叩くことが出来ますが、トークン情報はローカル用のものが付与されてしまうため、手動で上書きする必要があります。
第二引数内に入力したiプロパティは無視されるため、第三引数にトークンを入れて上書きすることになりますが、ここで""を渡すと空文字のトークンとして認識されて認証エラーに、nullを渡すと以下の部分により型エラーとなります。

misskey/packages/frontend/src/scripts/aiscript/api.ts

Lines 35 to 40 in dc8a130

	'Mk:api': values.FN_NATIVE(async ([ep, param, token]) => {
	if (token) {
	utils.assertString(token);
	// バグがあればundefinedもあり得るため念のため
	if (typeof token.value !== 'string') throw new Error('invalid token');
	}

第三引数にnullを渡すことが出来れば、credentialが不要なエンドポイントをトークン無しでそのまま叩けるようになるはずです。

参考

第一引数でURLそのものを渡すことが出来る理由と思しき場所

misskey/packages/frontend/src/scripts/api.ts

Line 26 in dc8a130

window.fetch(endpoint.indexOf('://') > -1 ? endpoint : `${apiUrl}/${endpoint}`, {

nullを渡せばトークン無しで叩けると考える理由

misskey/packages/frontend/src/scripts/api.ts

Lines 21 to 23 in dc8a130

	// Append a credential
	if ($i) (data as any).i = $i.token;
	if (token !== undefined) (data as any).i = token;

追記:
ログアウト状態でMk:api()を使った場合はtokenがnullになるようになっていました。

misskey/packages/frontend/src/scripts/aiscript/api.ts

Line 43 in dc8a130

const res = await os.api(ep.value, utils.valToJs(param), token ? token.value : (opts.token ?? null));

そのため、型チェックのところだけ修正出来れば対応出来そうですね…

[syuilo]

Mk:api()では第一引数にURLそのものを渡すことが出来るため、リモートのエンドポイントも叩くことが出来ますが、

Mk:apiはそのサーバーのAPIを叩くことを想定しているので、リモートのエンドポイントを叩けてしまうことがバグかも

リモートサーバーのAPIを叩きたいユースケースがあるのであればそれ用の関数を新たに用意した方が良さそう

[Sayamame-beans]

リモートサーバーのAPIを叩きたいユースケース

Mk:api()でリモートのAPIが叩ける挙動は、こちらのプラグインの作成に協力した際に発見しました。

当該ノートをリモートサーバーで開くメニューを追加するプラグインです
https://misskey.io/notes/9i6v7qwpf5

ローカルで完結するプラグインならローカルのAPIが叩ければ問題無いですが、リモートの情報や自アカウントを絡めた動作を行いたい場合は必要になってくると思います。(例えば、投稿したノートを別のサーバーの自アカウントにRenoteさせるためのプラグインなど。この例はRenoteのためにトークンが必要ですが…)

(※この挙動を見つけるまでは、ローカルで完結しない動作を行う場合はブラウザ拡張を作成するしかないと思っており、それは面倒だな…となっていました)

[FineArchs]

将来的にPlayに権限を設定できるようになったら「外部との通信」の項目を入れてもいいかもしれませんね

[Sayamame-beans]

#11883 により目的が達成されなくなったのでCloseします。