@talex-touch/utils 1.0.2 → 1.0.4

package/package.json

@@ -1,29 +1,29 @@
-{
-  "main": "./index.ts",
-  "name": "@talex-touch/utils",
-  "author": "TalexDreamSoul",
-  "module": "./index.ts",
-  "license": "MPL-2.0",
-  "private": false,
-  "version": "1.0.2",
-  "scripts": {
-    "publish": "npm publish --access public"
-  },
-  "keywords": [
-    "vue",
-    "electron",
-    "talex-touch"
-  ],
-  "repository": {
-    "url": "https://github.com/talex-touch/talex-touch.git",
-    "type": "git"
-  },
-  "description": "TalexTouch series utils",
-  "dependencies": {
-    "vue": "^3.2.47"
-  },
-  "peerDependencies": {
-    "vue": "^3.2.47",
-    "electron": "^24.4.0"
-  }
-}
+{
+  "main": "./index.ts",
+  "name": "@talex-touch/utils",
+  "author": "TalexDreamSoul",
+  "module": "./index.ts",
+  "license": "MPL-2.0",
+  "private": false,
+  "version": "1.0.4",
+  "scripts": {
+    "publish": "npm publish --access public"
+  },
+  "keywords": [
+    "vue",
+    "electron",
+    "talex-touch"
+  ],
+  "repository": {
+    "url": "https://github.com/talex-touch/talex-touch.git",
+    "type": "git"
+  },
+  "description": "TalexTouch series utils",
+  "dependencies": {
+    "vue": "^3.3.4"
+  },
+  "peerDependencies": {
+    "vue": "^3.2.47",
+    "electron": "^24.4.0"
+  }
+}

package/permission/index.ts

@@ -0,0 +1,50 @@
+export interface Permission {
+  /**
+   * permission id
+   */
+  id: symbol;
+
+  /**
+   * permission name
+   */
+  name: string;
+
+  /**
+   * permission description
+   */
+  description: string;
+}
+
+// generate a permission manager interface
+export interface IPermissionCenter {
+  /**
+   * add a permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   * @throws if permission already exists
+   */
+  addPermission(pluginScope: string, permission: Permission): void;
+
+  /**
+   * remove a permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   * @throws if permission not exists
+   */
+  delPermission(pluginScope: string, permission: Permission): void;
+
+  /**
+   * if pluginScope has permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   */
+  hasPermission(pluginScope: string, permission: Permission): boolean;
+
+  /**
+   * get permission
+   * @param pluginScope plugin name
+   * @param permission permission id
+   * @returns permission
+   */
+  getPermission(pluginScope: string, permission: symbol): Permission;
+}

package/plugin/index.ts

@@ -26,7 +26,7 @@ export interface IPlatformInfo {
 export type PlatformKey = 'win' | 'darwin' | 'linux'
 
 export type IPlatform = {
-  [key in PlatformKey]: IPlatformInfo
+  [key in PlatformKey]?: IPlatformInfo
 }
 
 export interface IPluginBaseInfo {
@@ -35,6 +35,7 @@ export interface IPluginBaseInfo {
   version: string
   desc: string
   icon: IPluginIcon
+  platforms: IPlatform
 }
 
 export interface IPluginDev {

package/plugin/preload.ts

@@ -1,4 +1,5 @@
 import { touchChannel } from './channel'
+import './sdk/index'
 
 // window type
 declare global {

package/plugin/sdk/hooks/index.ts

@@ -0,0 +1 @@
+export * as LifeCycle from './life-cycle'

package/plugin/sdk/hooks/life-cycle.ts

@@ -0,0 +1,91 @@
+import { touchChannel } from './../../channel';
+
+export enum LifecycleHooks {
+  ENABLE = 'en',
+  DISABLE = 'di',
+  ACTIVE = 'ac',
+  INACTIVE = 'in',
+  // FORE_PAUSED = 'fp',
+  CRASH = 'cr'
+}
+
+export function injectHook(type: LifecycleHooks, hook: Function, processFunc = ({ data, reply }) => {
+  const hooks: Array<Function> = window.$touchSDK.__hooks[type]
+  if (hooks) {
+    hooks.forEach(hook => hook(data))
+  }
+  reply(true)
+}) {
+  const __hooks = window.$touchSDK.__hooks
+  const hooks: Array<Function> = __hooks[type] || (__hooks[type] = [])
+
+  if (hooks.length === 0) {
+
+    touchChannel.regChannel("@lifecycle:" + type, obj => {
+
+      processFunc(obj)
+
+      delete window.$touchSDK.__hooks[type]
+    })
+
+  }
+
+  const wrappedHook = (data: any) => {
+
+    try {
+
+      hook(data)
+
+    } catch (e) {
+      console.error(`[TouchSDK] ${type} hook error: `, e)
+    }
+
+  }
+
+  hooks.push(wrappedHook)
+
+  return wrappedHook
+}
+
+export const createHook = <T extends Function = (data: any) => any>(type: LifecycleHooks) => (hook: T) => injectHook(type, hook)
+
+/**
+ * The plugin is enabled
+ * When the plugin is enabled, the plugin can be used
+ * @returns void
+ */
+export const onPluginEnable = createHook(LifecycleHooks.ENABLE)
+
+/**
+ * The plugin is disabled
+ * When the plugin is disabled, the plugin can not be used
+ * @returns void
+ */
+export const onPluginDisable = createHook(LifecycleHooks.DISABLE)
+
+/**
+ * The plugin is activated
+ * @returns boolean If return false, the plugin will not be activated (User can force to activate the plugin)
+ */
+export const onPluginActive = createHook(LifecycleHooks.ACTIVE)
+
+/**
+ * The plugin is inactivated
+ * @returns boolean If return false, the plugin will not be inactivated (User can force to inactivate the plugin)
+ */
+export const onPluginInactive = createHook(LifecycleHooks.INACTIVE)
+
+/**
+ * When plugin is in foreground (e.g. plugin is using media, camera, microphone, etc.) But paused by user
+ * For a detail example: User force to stop music playing
+ * @returns void
+ */
+// export const onForePaused = createHook(LifecycleHooks.FORE_PAUSED)
+
+/**
+ * When plugin is crashed
+ * data.message Crash message
+ * data.extraData Crash data
+ * @returns void
+ */
+export const onCrash = createHook(LifecycleHooks.CRASH)

package/plugin/sdk/index.ts

@@ -0,0 +1,13 @@
+import * as HOOKS from './hooks/index'
+
+export interface ITouchSDK {
+  hooks: typeof HOOKS
+  __hooks: {}
+}
+
+// window type
+declare global {
+  export interface Window {
+    $touchSDK: ITouchSDK
+  }
+}