refactor: export API permission map objects

packages/tauri-api-adapter/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tauri-api-adapter",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/HuakunShen/tauri-api-adapter.git"
@@ -39,7 +39,7 @@
   },
   "scripts": {
     "dev": "rollup -c --watch",
-    "build:docs": "shx cp ../../README.md ./README.md && typedoc src/index.ts",
+    "build:docs": "shx cp ../../README.md ./README.md && typedoc",
     "build": "rimraf dist && rollup -c && pnpm build:docs",
     "test": "bun test --coverage"
   },

packages/tauri-api-adapter/rollup.config.js

@@ -8,7 +8,7 @@ const pkg = JSON.parse(readFileSync(join(cwd(), 'package.json'), 'utf8'))
 
 /** @type {import('rollup').RollupOptions} */
 const config = {
-  input: ['src/index.ts', 'src/native.ts', 'src/worker.ts', 'src/iframe.ts', 'src/permissions.ts'],
+  input: ['src/index.ts', 'src/native.ts', 'src/worker.ts', 'src/iframe.ts', 'src/permissions/index.ts'],
   output: [
     {
       dir: 'dist',

packages/tauri-api-adapter/src/permissions/index.ts

@@ -0,0 +1,3 @@
+export * from './util'
+export * from './schema'
+export * from './permission-map'

packages/tauri-api-adapter/src/permissions/permission-map.ts

@@ -0,0 +1,160 @@
+import type {
+  IClipboardServer,
+  IDialogServer,
+  IFetchServer,
+  IFsServer,
+  INetworkServer,
+  INotificationServer,
+  IOsServer,
+  IShellServer,
+  ISystemInfoServer,
+  IUpdownloadServer
+} from '../api/server-types'
+import type {
+  ClipboardPermission,
+  DialogPermission,
+  FetchPermission,
+  FsPermission,
+  NetworkPermission,
+  NotificationPermission,
+  OsPermission,
+  ShellPermission,
+  SystemInfoPermission,
+  UpdownloadPermission
+} from './schema'
+
+/**
+ * Map an API function name to its required permissions.
+ * This type is only suitable for simple API permissions that maps one function to an array of permission strings.
+ * No scoped permissions are supported.
+ * Scoped permission is an object with more fine-grained permissions.
+ */
+
+export const ClipboardPermissionMap: Record<keyof IClipboardServer, ClipboardPermission[]> = {
+  clipboardReadText: ['clipboard:read-text', 'clipboard:read-all'],
+  clipboardWriteText: ['clipboard:write-text', 'clipboard:write-all'],
+  clipboardReadImageBase64: ['clipboard:read-all', 'clipboard:read-image'],
+  clipboardReadImageBinary: ['clipboard:read-all', 'clipboard:read-image'],
+  clipboardWriteImageBase64: ['clipboard:write-all', 'clipboard:write-image'],
+  clipboardWriteImageBinary: ['clipboard:write-all', 'clipboard:write-image'],
+  clipboardReadFiles: ['clipboard:read-all', 'clipboard:read-files'],
+  clipboardWriteFiles: ['clipboard:write-all', 'clipboard:write-files'],
+  clipboardReadRtf: ['clipboard:read-all', 'clipboard:read-text'],
+  clipboardWriteRtf: ['clipboard:write-all', 'clipboard:write-text'],
+  clipboardReadHtml: ['clipboard:read-all', 'clipboard:read-text'],
+  clipboardWriteHtml: ['clipboard:write-all', 'clipboard:write-text'],
+  clipboardWriteHtmlAndText: ['clipboard:write-all', 'clipboard:write-text'],
+  clipboardHasText: [],
+  clipboardHasRTF: [],
+  clipboardHasHTML: [],
+  clipboardHasImage: [],
+  clipboardHasFiles: []
+}
+
+export const DialogPermissionMap: Record<keyof IDialogServer, DialogPermission[]> = {
+  dialogAsk: ['dialog:all'],
+  dialogConfirm: ['dialog:all'],
+  dialogMessage: ['dialog:all'],
+  dialogOpen: ['dialog:all'],
+  dialogSave: ['dialog:all']
+}
+
+export const NotificationPermissionMap: Record<keyof INotificationServer, NotificationPermission[]> = {
+  notificationSendNotification: ['notification:all'],
+  notificationRequestPermission: ['notification:all'],
+  notificationIsPermissionGranted: ['notification:all'],
+  notificationRegisterActionTypes: ['notification:all'],
+  notificationPending: ['notification:all'],
+  notificationCancel: ['notification:all'],
+  notificationCancelAll: ['notification:all'],
+  notificationActive: ['notification:all'],
+  notificationRemoveActive: ['notification:all'],
+  notificationRemoveAllActive: ['notification:all'],
+  notificationCreateChannel: ['notification:all'],
+  notificationRemoveChannel: ['notification:all'],
+  notificationChannels: ['notification:all'],
+  notificationOnNotificationReceived: ['notification:all'],
+  notificationOnAction: ['notification:all']
+}
+
+export const FsPermissionMap: Record<keyof IFsServer, FsPermission[]> = {
+  fsReadDir: ['fs:read'],
+  fsReadFile: ['fs:read'],
+  fsReadTextFile: ['fs:read'],
+  fsStat: ['fs:read'],
+  fsLstat: ['fs:read'],
+  fsExists: ['fs:read', 'fs:exists'],
+  fsMkdir: ['fs:write'],
+  fsCreate: ['fs:write'],
+  fsCopyFile: ['fs:write'],
+  fsRemove: ['fs:write'],
+  fsRename: ['fs:write'],
+  fsTruncate: ['fs:write'],
+  fsWriteFile: ['fs:write'],
+  fsWriteTextFile: ['fs:write']
+}
+
+export const OsPermissionMap: Record<keyof IOsServer, OsPermission[]> = {
+  osPlatform: [],
+  osArch: ['os:all'],
+  osExeExtension: ['os:all'],
+  osFamily: ['os:all'],
+  osHostname: ['os:all'],
+  osEol: ['os:all'],
+  osVersion: ['os:all'],
+  osLocale: ['os:all']
+}
+
+export const FetchPermissionMap: Record<keyof IFetchServer, FetchPermission[]> = {
+  fetchRawFetch: ['fetch:all'],
+  fetchFetchCancel: ['fetch:all'],
+  fetchFetchSend: ['fetch:all'],
+  fetchFetchReadBody: ['fetch:all']
+}
+
+export const SystemInfoPermissionMap: Record<keyof ISystemInfoServer, SystemInfoPermission[]> = {
+  sysInfoAllSysInfo: ['system-info:all'],
+  sysInfoTotalMemory: ['system-info:all', 'system-info:memory'],
+  sysInfoUsedMemory: ['system-info:all', 'system-info:memory'],
+  sysInfoTotalSwap: ['system-info:all', 'system-info:memory'],
+  sysInfoUsedSwap: ['system-info:all', 'system-info:memory'],
+  sysInfoMemoryInfo: ['system-info:all', 'system-info:memory'],
+  sysInfoHostname: ['system-info:all', 'system-info:network'],
+  sysInfoName: ['system-info:all', 'system-info:os'],
+  sysInfoKernelVersion: ['system-info:all', 'system-info:os'],
+  sysInfoOsVersion: ['system-info:all', 'system-info:os'],
+  sysInfoStaticInfo: ['system-info:all', 'system-info:os'],
+  sysInfoComponents: ['system-info:all', 'system-info:components'],
+  sysInfoCpus: ['system-info:all', 'system-info:cpu'],
+  sysInfoCpuCount: ['system-info:all', 'system-info:cpu'],
+  sysInfoCpuInfo: ['system-info:all', 'system-info:cpu'],
+  sysInfoDisks: ['system-info:all', 'system-info:disk'],
+  sysInfoNetworks: ['system-info:all', 'system-info:network'],
+  sysInfoProcesses: ['system-info:all', 'system-info:process'],
+  sysInfoRefreshAll: ['system-info:all'],
+  sysInfoRefreshMemory: ['system-info:all', 'system-info:memory'],
+  sysInfoRefreshCpu: ['system-info:all', 'system-info:cpu'],
+  sysInfoRefreshProcesses: ['system-info:all', 'system-info:process'],
+  sysInfoBatteries: ['system-info:all', 'system-info:battery']
+}
+
+export const ShellPermissionMap: Record<keyof IShellServer, ShellPermission[]> = {
+  shellExecute: ['shell:execute'],
+  shellKill: ['shell:execute'],
+  shellStdinWrite: ['shell:execute'],
+  shellOpen: ['shell:open'],
+  shellRawSpawn: ['shell:execute'],
+  shellExecuteBashScript: ['shell:execute'],
+  shellExecutePowershellScript: ['shell:execute'],
+  shellExecuteAppleScript: ['shell:execute'],
+  shellExecutePythonScript: ['shell:execute'],
+  shellExecuteZshScript: ['shell:execute'],
+  shellExecuteNodeScript: ['shell:execute'],
+  shellHasCommand: ['shell:execute'],
+  shellLikelyOnWindows: ['shell:execute']
+}
+
+export const UpdownloadPermissionMap: Record<keyof IUpdownloadServer, UpdownloadPermission[]> = {
+  upload: ['updownload:upload'],
+  download: ['updownload:download']
+}

packages/tauri-api-adapter/src/permissions.ts → packages/tauri-api-adapter/src/permissions/schema.ts

@@ -62,20 +62,3 @@ export const AllPermissionSchema = union([
   UpdownloadPermissionSchema
 ])
 export type AllPermission = InferOutput<typeof AllPermissionSchema>
-
-export function checkPermission<P>(requiredPermissions: P[], userPermissions: P[]) {
-  return <T extends (...args: any[]) => any>(fn: T): T => {
-    return ((...args: any[]) => {
-      if (
-        requiredPermissions.length > 0 &&
-        !requiredPermissions.some((permission) => userPermissions.includes(permission))
-      ) {
-        // throw new Error(`Permission denied. Required: ${requiredPermissions.join(', ')}`)
-        throw new Error(
-          `Permission denied for API "${fn.name}". Require one of these: [${requiredPermissions.join(', ')}]`
-        )
-      }
-      return fn(...args)
-    }) as T
-  }
-}

packages/tauri-api-adapter/src/permissions/util.ts

@@ -0,0 +1,16 @@
+export function checkPermission<P>(requiredPermissions: P[], userPermissions: P[]) {
+  return <T extends (...args: any[]) => any>(fn: T): T => {
+    return ((...args: any[]) => {
+      if (
+        requiredPermissions.length > 0 &&
+        !requiredPermissions.some((permission) => userPermissions.includes(permission))
+      ) {
+        // throw new Error(`Permission denied. Required: ${requiredPermissions.join(', ')}`)
+        throw new Error(
+          `Permission denied for API "${fn.name}". Require one of these: [${requiredPermissions.join(', ')}]`
+        )
+      }
+      return fn(...args)
+    }) as T
+  }
+}