feat(js): plugin utilities

close #89

Author: std-microblock

scripts/bindgen/quickjs-types.txt

@@ -13,3 +13,25 @@ declare module "mshell" {
     type uintptr_t = number;
     type ssize_t = number;
 }
+
+// helper to access field based on dot path
+type FieldPath<T, K extends string> = K extends keyof T ? T[K] : K extends `${infer K1}.${infer K2}` ? K1 extends keyof T ? FieldPath<T[K1], K2> : never : never;
+
+declare function plugin<T = object>(import_meta: { name: string; url: string }, default_config?: T): {
+    i18n: {
+        define(lang: string, data: { [key: string]: string }): void;
+        t(key: string): string;
+    };
+    set_on_menu(callback: (m:
+        import('mshell').menu_controller
+    ) => void): void;
+    config_directory: string;
+    config: {
+        read_config(): void;
+        write_config(): void;
+        get<K extends string>(key: K): FieldPath<T, K>;
+        set<K extends string>(key: K, value: FieldPath<T, K>): void;
+        all(): T;
+    };
+    log(...args: any[]): void;
+};

src/shell/script/binding_qjs.h

@@ -56,6 +56,8 @@ template <> struct qjs::js_traits<mb_shell::js::folder_view_folder_item> {
 
         obj.index = js_traits<int>::unwrap(ctx, JS_GetPropertyStr(ctx, v, "index"));
 
+        obj.parent_path = js_traits<std::string>::unwrap(ctx, JS_GetPropertyStr(ctx, v, "parent_path"));
+        
         return obj;
     }
 
@@ -64,6 +66,8 @@ template <> struct qjs::js_traits<mb_shell::js::folder_view_folder_item> {
 
         JS_SetPropertyStr(ctx, obj, "index", js_traits<int>::wrap(ctx, val.index));
 
+        JS_SetPropertyStr(ctx, obj, "parent_path", js_traits<std::string>::wrap(ctx, val.parent_path));
+        
         return obj;
     }
 };
@@ -78,6 +82,7 @@ template<> struct js_bind<mb_shell::js::folder_view_folder_item> {
                 .fun<&mb_shell::js::folder_view_folder_item::type>("type")
                 .fun<&mb_shell::js::folder_view_folder_item::select>("select")
                 .fun<&mb_shell::js::folder_view_folder_item::index>("index")
+                .fun<&mb_shell::js::folder_view_folder_item::parent_path>("parent_path")
             ;
     }
 

src/shell/script/binding_types.d.ts

@@ -28,6 +28,7 @@ export class example_struct_jni {
 
 export class folder_view_folder_item {
 	index: number
+	parent_path: string
 
 /**
   * 
@@ -1342,3 +1343,25 @@ declare module "mshell" {
     type uintptr_t = number;
     type ssize_t = number;
 }
+
+// helper to access field based on dot path
+type FieldPath<T, K extends string> = K extends keyof T ? T[K] : K extends `${infer K1}.${infer K2}` ? K1 extends keyof T ? FieldPath<T[K1], K2> : never : never;
+
+declare function plugin<T = object>(import_meta: { name: string; url: string }, default_config?: T): {
+    i18n: {
+        define(lang: string, data: { [key: string]: string }): void;
+        t(key: string): string;
+    };
+    set_on_menu(callback: (m:
+        import('mshell').menu_controller
+    ) => void): void;
+    config_directory: string;
+    config: {
+        read_config(): void;
+        write_config(): void;
+        get<K extends string>(key: K): FieldPath<T, K>;
+        set<K extends string>(key: K, value: FieldPath<T, K>): void;
+        all(): T;
+    };
+    log(...args: any[]): void;
+};

src/shell/script/script.js

@@ -45,8 +45,88 @@ const splitIntoLines = (str, maxLen) => {
     return lines
 }
 
+// Breeze infrastructure
+
 globalThis.on_plugin_menu = {};
 
+const plugin = (import_meta, default_config = {}) => {
+    const CONFIG_FILE = '/config.json'
+
+    const { name, url } = import_meta
+    const languages = {}
+
+    const nameNoExt = name.endsWith('.js') ? name.slice(0, -3) : name
+
+    let config = default_config
+
+    const plugin = {
+        i18n: {
+            define: (lang, data) => {
+                languages[lang] = data
+            },
+            t: (key) => {
+                return languages[shell.breeze.user_language()][key] || key
+            }
+        },
+        set_on_menu: (callback) => {
+            on_plugin_menu[nameNoExt] = callback
+        },
+        config_directory: shell.breeze.data_directory() + '/config/' + nameNoExt,
+        config: {
+            read_config() {
+                if (shell.fs.exists(plugin.config_directory + CONFIG_FILE)) {
+                    try {
+                        config = JSON.parse(shell.fs.read(config_dir + CONFIG_FILE))
+                    } catch (e) {
+                        shell.println(`[${name}] 配置文件解析失败: ${e}`)
+                    }
+                }
+            },
+            write_config() {
+                shell.fs.write(plugin.config_directory + CONFIG_FILE, JSON.stringify(config, null, 4))
+            },
+            get(key) {
+                const read = (keys, obj) => {
+                    if (keys.length === 1) {
+                        return obj[keys[0]]
+                    }
+                    if (!obj[keys[0]]) {
+                        return undefined
+                    }
+                    return read(keys.slice(1), obj[keys[0]])
+                }
+
+                return read(key.split('.'), config)
+            },
+            set(key, value) {
+                let obj = config
+
+                const keys = key.split('.')
+                for (let i = 0; i < keys.length - 1; i++) {
+                    if (!obj[keys[i]]) {
+                        obj[keys[i]] = {}
+                    }
+                    obj = obj[keys[i]]
+                }
+                obj[keys[keys.length - 1]] = value
+
+                plugin.config.write_config()
+            },
+            all() {
+                return config
+            }
+        },
+        log(...args) {
+            shell.println(`[${name}]`, ...args)
+        }
+    }
+
+    shell.fs.mkdir(plugin.config_directory)
+    return plugin
+}
+
+globalThis.plugin = plugin
+
 const languages = {
     'zh-CN': {
     },
@@ -93,7 +173,7 @@ shell.menu_controller.add_menu_listener(ctx => {
                             sub.append_menu({
                                 name: t('加载中...')
                             })
-                            
+
                             if (!cached_plugin_index) {
                                 cached_plugin_index = await get_async(PLUGIN_SOURCES[current_source] + 'plugins-index.json')
                             }