Refine preferences (#15597)
* wip
* wip
* wip
* test
* wip rollup pluginでsearchIndexの情報生成
* wip
* SPDX
* wip: markerIdを自動付与
* rollupでビルド時・devモード時に毎回uuidを生成するように
* 開発サーバーでだけ必要な挙動は開発サーバーのみで
* 条件が逆
* wip: childrenの生成
* update comment
* update comment
* rename auto generated file
* hashをパスと行数から決定
* Update privacy.vue
* Update privacy.vue
* wip
* Update general.vue
* Update general.vue
* wip
* wip
* Update SearchMarker.vue
* wip
* Update profile.vue
* Update mute-block.vue
* Update mute-block.vue
* Update general.vue
* Update general.vue
* childrenがduplicate key errorを吐く問題をいったん解決
* マーカーの形を成形
* loggerを置きかえ
* とりあえず省略記法に対応
* Refactor and Format codes
* wip
* Update settings-search-index.ts
* wip
* wip
* とりあえず不確定要因の仮置きidを削除
* hashの生成を正規化（絶対パスになっていたのを緩和）
* pathの入力を省略可能に
* adminでもパス生成できるように
* Update settings-search-index.ts
* Update privacy.vue
* wip
* build searchIndex
* wip
* build
* Update general.vue
* build
* Update sounds.vue
* build
* build
* Update sounds.vue
* 🎨
* 🎨
* Update privacy.vue
* Update privacy.vue
* Update security.vue
* create-search-indexを多少改善
* build
* Update 2fa.vue
* wip
* 必ずtransformCodeCacheを利用するように, キャッシュの明確な受け渡しを定義
* キャッシュはdevServerでなくても更新
* Revert "wip"
This reverts commit 41bffd3a13.
* inlining
* wip
* Update theme.vue
* 🎨
* wip normalize
* Update theme.vue
* キャッシュのパス変換
* build
* wip
* wip
* Update SearchMarker.vue
* i18n.ts['key'] の形式が取り出せない問題のFix
* build
* 仮でpath入れ
* 必ず絶対パスが使われるように
* wip
* 🎨
* storybookビルド時はcreateSearchIndexをしない
* inliningの構造化
* format code
* Update index.vue
* wip
* wip
* 🎨
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* wip
* clean up
* wip
* wip
* wip
* Update rollup-plugin-unwind-css-module-class-name.test.ts
* Update navbar.vue
* clean up
* wip
* wip
* wip
* wip
* wip
* Update preferences-backups.vue
* Update common.ts
* Update preferences.ts
* wip
* wip
* wip
* wip
* Update MkPreferenceContainer.vue
* Update MkPreferenceContainer.vue
* Update MkPreferenceContainer.vue
* enhance: 検索で上下矢印を使用することで検索結果を移動できるように
* Update main-boot.ts
* refactor
* wip
* Update sounds.vue
* fix(frontend): PageWindowでSearchMarkerが動作するように
* enhance(frontend): SearchMarkerの点滅を一定時間で止める
* wip
* lint fix
* fix: 子要素監視が抜けていたのを修正
* アニメーションの回数はCSSで制御するように
* refactor
* enhance(frontend): 検索インデックス作成時のログを削減
* revert
* fix
* fix
* Update preferences.ts
* Update preferences.ts
* wip
* Update preferences.ts
* wip
* 🎨
* wip
* Update MkPreferenceContainer.vue
* wip
* Update preferences.ts
* wip
* Update preferences.ts
* Update preferences.ts
* wip
* wip
* Update preferences.ts
* wip
* wip
* Update preferences.ts
* Update CHANGELOG.md
* Update preferences.ts
* Update deck-store.ts
* deckStoreをdefaultStoreに統合
* wip
* defaultStore -> store
* Update profile.ts
* wip
* refactor
* wip: plugin
* plugin
* plugin
* plugin
* Update plugin.ts
* wip
* Update plugin.vue
* Update preferences.ts
* Update main-boot.ts
* wip
* fix test
* Update plugin.vue
* Update plugin.vue
* Update utility.ts
* wip
* wip
* Update utility.ts
* wip
* wip
* clean up
* Update utility.ts
---------
Co-authored-by: tai-cha <dev@taichan.site>
Co-authored-by: taichan <40626578+tai-cha@users.noreply.github.com>
Co-authored-by: kakkokari-gtyih <67428053+kakkokari-gtyih@users.noreply.github.com>
This commit is contained in:
syuilo
236
packages/frontend/src/preferences/profile.ts
Normal file
236
packages/frontend/src/preferences/profile.ts
Normal file
@@ -0,0 +1,236 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: syuilo and misskey-project
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
import { ref, watch } from 'vue';
|
||||
import { v4 as uuid } from 'uuid';
|
||||
import { host, version } from '@@/js/config.js';
|
||||
import { EventEmitter } from 'eventemitter3';
|
||||
import { PREF_DEF } from './def.js';
|
||||
import { Store } from './store.js';
|
||||
import type { MenuItem } from '@/types/menu.js';
|
||||
import { $i } from '@/account.js';
|
||||
import { copyToClipboard } from '@/scripts/copy-to-clipboard.js';
|
||||
import { i18n } from '@/i18n.js';
|
||||
|
||||
// NOTE: 明示的な設定値のひとつとして null もあり得るため、設定が存在しないかどうかを判定する目的で null で比較したり ?? を使ってはいけない
|
||||
|
||||
//type DottedToNested<T extends Record<string, any>> = {
|
||||
// [K in keyof T as K extends string ? K extends `${infer A}.${infer B}` ? A : K : K]: K extends `${infer A}.${infer B}` ? DottedToNested<{ [key in B]: T[K] }> : T[K];
|
||||
//};
|
||||
|
||||
type PREF = typeof PREF_DEF;
|
||||
type ValueOf<K extends keyof PREF> = PREF[K]['default'];
|
||||
type Account = string; // <host>/<userId>
|
||||
|
||||
type Cond = {
|
||||
server: string | null; // 将来のため
|
||||
account: Account | null;
|
||||
device: string | null; // 将来のため
|
||||
};
|
||||
|
||||
export type PreferencesProfile = {
|
||||
id: string;
|
||||
version: string;
|
||||
type: 'main';
|
||||
modifiedAt: number;
|
||||
name: string;
|
||||
preferences: {
|
||||
[K in keyof PREF]: [Cond, ValueOf<K>][];
|
||||
};
|
||||
syncByAccount: [Account, keyof PREF][],
|
||||
};
|
||||
|
||||
export class ProfileManager extends EventEmitter<{
|
||||
updated: (ctx: {
|
||||
profile: PreferencesProfile
|
||||
}) => void;
|
||||
}> {
|
||||
public profile: PreferencesProfile;
|
||||
public store: Store<{
|
||||
[K in keyof PREF]: ValueOf<K>;
|
||||
}>;
|
||||
|
||||
constructor(profile: PreferencesProfile) {
|
||||
super();
|
||||
this.profile = profile;
|
||||
|
||||
const states = this.genStates();
|
||||
|
||||
this.store = new Store(states);
|
||||
this.store.addListener('updated', ({ key, value }) => {
|
||||
console.log('prefer:set', key, value);
|
||||
|
||||
const record = this.getMatchedRecord(key);
|
||||
if (record[0].account == null && PREF_DEF[key].accountDependent) {
|
||||
this.profile.preferences[key].push([{
|
||||
server: null,
|
||||
account: `${host}/${$i!.id}`,
|
||||
device: null,
|
||||
}, value]);
|
||||
this.save();
|
||||
return;
|
||||
}
|
||||
|
||||
record[1] = value;
|
||||
this.save();
|
||||
});
|
||||
}
|
||||
|
||||
private genStates() {
|
||||
const states = {} as { [K in keyof PREF]: ValueOf<K> };
|
||||
let key: keyof PREF;
|
||||
for (key in PREF_DEF) {
|
||||
const record = this.getMatchedRecord(key);
|
||||
states[key] = record[1];
|
||||
}
|
||||
|
||||
return states;
|
||||
}
|
||||
|
||||
public static newProfile(): PreferencesProfile {
|
||||
const data = {} as PreferencesProfile['preferences'];
|
||||
let key: keyof PREF;
|
||||
for (key in PREF_DEF) {
|
||||
data[key] = [[{
|
||||
server: null,
|
||||
account: null,
|
||||
device: null,
|
||||
}, PREF_DEF[key].default]];
|
||||
}
|
||||
return {
|
||||
id: uuid(),
|
||||
version: version,
|
||||
type: 'main',
|
||||
modifiedAt: Date.now(),
|
||||
name: '',
|
||||
preferences: data,
|
||||
syncByAccount: [],
|
||||
};
|
||||
}
|
||||
|
||||
public static normalizeProfile(profile: any): PreferencesProfile {
|
||||
const data = {} as PreferencesProfile['preferences'];
|
||||
let key: keyof PREF;
|
||||
for (key in PREF_DEF) {
|
||||
const records = profile.preferences[key];
|
||||
if (records == null || records.length === 0) {
|
||||
data[key] = [[{
|
||||
server: null,
|
||||
account: null,
|
||||
device: null,
|
||||
}, PREF_DEF[key].default]];
|
||||
continue;
|
||||
} else {
|
||||
data[key] = records;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
...profile,
|
||||
preferences: data,
|
||||
};
|
||||
}
|
||||
|
||||
public save() {
|
||||
this.profile.modifiedAt = Date.now();
|
||||
this.profile.version = version;
|
||||
this.emit('updated', { profile: this.profile });
|
||||
}
|
||||
|
||||
public getMatchedRecord<K extends keyof PREF>(key: K): [Cond, ValueOf<K>] {
|
||||
const records = this.profile.preferences[key];
|
||||
|
||||
if ($i == null) return records.find(([cond, v]) => cond.account == null)!;
|
||||
|
||||
const accountOverrideRecord = records.find(([cond, v]) => cond.account === `${host}/${$i!.id}`);
|
||||
if (accountOverrideRecord) return accountOverrideRecord;
|
||||
|
||||
const record = records.find(([cond, v]) => cond.account == null);
|
||||
return record!;
|
||||
}
|
||||
|
||||
public isAccountOverrided<K extends keyof PREF>(key: K): boolean {
|
||||
if ($i == null) return false;
|
||||
return this.profile.preferences[key].some(([cond, v]) => cond.account === `${host}/${$i!.id}`) ?? false;
|
||||
}
|
||||
|
||||
public setAccountOverride<K extends keyof PREF>(key: K) {
|
||||
if ($i == null) return;
|
||||
if (PREF_DEF[key].accountDependent) throw new Error('already account-dependent');
|
||||
if (this.isAccountOverrided(key)) return;
|
||||
|
||||
const records = this.profile.preferences[key];
|
||||
records.push([{
|
||||
server: null,
|
||||
account: `${host}/${$i!.id}`,
|
||||
device: null,
|
||||
}, this.store.s[key]]);
|
||||
|
||||
this.save();
|
||||
}
|
||||
|
||||
public clearAccountOverride<K extends keyof PREF>(key: K) {
|
||||
if ($i == null) return;
|
||||
if (PREF_DEF[key].accountDependent) throw new Error('cannot clear override for this account-dependent property');
|
||||
|
||||
const records = this.profile.preferences[key];
|
||||
|
||||
const index = records.findIndex(([cond, v]) => cond.account === `${host}/${$i!.id}`);
|
||||
if (index === -1) return;
|
||||
|
||||
records.splice(index, 1);
|
||||
|
||||
this.store.rewrite(key, this.getMatchedRecord(key)[1]);
|
||||
|
||||
this.save();
|
||||
}
|
||||
|
||||
public renameProfile(name: string) {
|
||||
this.profile.name = name;
|
||||
this.save();
|
||||
}
|
||||
|
||||
public rewriteProfile(profile: PreferencesProfile) {
|
||||
this.profile = profile;
|
||||
const states = this.genStates();
|
||||
for (const key in states) {
|
||||
this.store.rewrite(key, states[key]);
|
||||
}
|
||||
}
|
||||
|
||||
public getPerPrefMenu<K extends keyof PREF>(key: K): MenuItem[] {
|
||||
const overrideByAccount = ref(this.isAccountOverrided(key));
|
||||
|
||||
watch(overrideByAccount, () => {
|
||||
if (overrideByAccount.value) {
|
||||
this.setAccountOverride(key);
|
||||
} else {
|
||||
this.clearAccountOverride(key);
|
||||
}
|
||||
});
|
||||
|
||||
return [{
|
||||
icon: 'ti ti-copy',
|
||||
text: i18n.ts.copyPreferenceId,
|
||||
action: () => {
|
||||
copyToClipboard(key);
|
||||
},
|
||||
}, {
|
||||
icon: 'ti ti-refresh',
|
||||
text: i18n.ts.resetToDefaultValue,
|
||||
danger: true,
|
||||
action: () => {
|
||||
this.store.set(key, PREF_DEF[key].default);
|
||||
},
|
||||
}, {
|
||||
type: 'divider',
|
||||
}, {
|
||||
type: 'switch',
|
||||
icon: 'ti ti-user-cog',
|
||||
text: i18n.ts.overrideByAccount,
|
||||
ref: overrideByAccount,
|
||||
}];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user