feat: Plugin permissions component (tauri-apps#1890)

Co-authored-by: Paul Valladares <[email protected]>
Co-authored-by: Lucas Nogueira <[email protected]>

Author: 3 people

src/components/PluginPermissions.astro

@@ -0,0 +1,39 @@
+---
+import { createMarkdownProcessor } from '@astrojs/markdown-remark';
+import fs from 'fs/promises';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+interface Props {
+  plugin: string;
+}
+
+const { plugin } = Astro.props;
+
+async function importMDX(plugin: string): Promise<string> {
+  const base = fileURLToPath(import.meta.url);
+  const dirname = path.dirname(base);
+
+  const mdPath = path.join(
+    dirname,
+    '../../packages/plugins-workspace/plugins',
+    plugin,
+    'permissions/autogenerated',
+    'reference.md'
+  );
+
+  try {
+    const content = await fs.readFile(mdPath, 'utf-8');
+    return content;
+  } catch (err) {
+    console.error(`Error reading file ${mdPath}: ${err}`);
+    throw err;
+  }
+}
+const md = await createMarkdownProcessor();
+
+const pageContent: string = await importMDX(plugin);
+const content = await md.render(pageContent);
+---
+
+<Fragment set:html={content.code} />

src/content/docs/learn/Security/using-plugin-permissions.mdx

@@ -98,7 +98,7 @@ permissions are used.
 
     In the case of official maintained plugins you can find a
     rendered description in the documentation
-    (eg. [fs default](/plugin/file-system/#default-permissions)).
+    (eg. [fs default](/plugin/file-system/#permissions)).
 
     In case you are figuring this out for a community plugin you
     need to check out the source code of the plugin.
@@ -147,7 +147,7 @@ permissions are used.
       The `fs` plugin has autogenerated permissions which will disable
       or enable individual commands and allow or disable global scopes.
 
-      These can be found in the [documentation](/plugin/file-system/#command-permissions)
+      These can be found in the [documentation](/plugin/file-system/#permissions)
       or in the source code of the plugin (`fs/permissions/autogenerated`).
 
       Let us assume we want to enable writing to a text file `test.txt`

src/content/docs/plugin/autostart.mdx

@@ -10,6 +10,7 @@ sidebar:
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="autostart" />
 
@@ -144,11 +145,4 @@ See the [Capabilities Overview](/security/capabilities/) for more information an
 }
 ```
 
-| Permission                   | Description                                                      |
-| ---------------------------- | ---------------------------------------------------------------- |
-| `autostart:allow-disable`    | Enables the disable command without any pre-configured scope.    |
-| `autostart:deny-disable`     | Denies the disable command without any pre-configured scope.     |
-| `autostart:allow-enable`     | Enables the enable command without any pre-configured scope.     |
-| `autostart:deny-enable`      | Denies the enable command without any pre-configured scope.      |
-| `autostart:allow-is-enabled` | Enables the is_enabled command without any pre-configured scope. |
-| `autostart:deny-is-enabled`  | Denies the is_enabled command without any pre-configured scope.  |
+<PluginPermissions plugin="autostart" />

src/content/docs/plugin/barcode-scanner.mdx

@@ -10,6 +10,7 @@ sidebar:
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="barcode-scanner" />
 
@@ -104,17 +105,4 @@ See the [Capabilities Overview](/security/capabilities/) for more information an
 }
 ```
 
-| Permission                                  | Description                                                               |
-| ------------------------------------------- | ------------------------------------------------------------------------- |
-| `barcode-scanner:allow-cancel`              | Enables the cancel command without any pre-configured scope.              |
-| `barcode-scanner:deny-cancel`               | Denies the cancel command without any pre-configured scope.               |
-| `barcode-scanner:allow-check-permissions`   | Enables the check_permissions command without any pre-configured scope.   |
-| `barcode-scanner:deny-check-permissions`    | Denies the check_permissions command without any pre-configured scope.    |
-| `barcode-scanner:allow-open-app-settings`   | Enables the open_app_settings command without any pre-configured scope.   |
-| `barcode-scanner:deny-open-app-settings`    | Denies the open_app_settings command without any pre-configured scope.    |
-| `barcode-scanner:allow-request-permissions` | Enables the request_permissions command without any pre-configured scope. |
-| `barcode-scanner:deny-request-permissions`  | Denies the request_permissions command without any pre-configured scope.  |
-| `barcode-scanner:allow-scan`                | Enables the scan command without any pre-configured scope.                |
-| `barcode-scanner:deny-scan`                 | Denies the scan command without any pre-configured scope.                 |
-| `barcode-scanner:allow-vibrate`             | Enables the vibrate command without any pre-configured scope.             |
-| `barcode-scanner:deny-vibrate`              | Denies the vibrate command without any pre-configured scope.              |
+<PluginPermissions plugin="barcode-scanner" />

src/content/docs/plugin/biometric.mdx

@@ -9,6 +9,7 @@ sidebar:
 
 import Stub from '@components/Stub.astro';
 import PluginLinks from '@components/PluginLinks.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="biometric" />
 
@@ -17,3 +18,5 @@ import PluginLinks from '@components/PluginLinks.astro';
 Based on https://github.com/tauri-apps/plugins-workspace/tree/plugins/biometric
 
 </Stub>
+
+<PluginPermissions plugin="biometric" />

src/content/docs/plugin/cli.mdx

@@ -10,6 +10,7 @@ sidebar:
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="cli" />
 
@@ -283,8 +284,4 @@ See the [Capabilities Overview](/security/capabilities/) for more information an
 }
 ```
 
-| Permission              | Description                                                       |
-| ----------------------- | ----------------------------------------------------------------- |
-| `cli:default`           | Allows reading the CLI matches.                                   |
-| `cli:allow-cli-matches` | Enables the cli_matches command without any pre-configured scope. |
-| `cli:deny-cli-matches`  | Denies the cli_matches command without any pre-configured scope.  |
+<PluginPermissions plugin="cli" />

src/content/docs/plugin/clipboard.mdx

@@ -11,6 +11,7 @@ import Stub from '@components/Stub.astro';
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="clipboard-manager" />
 
@@ -111,3 +112,5 @@ println!("{:?}", content.unwrap());
 
 </TabItem>
 </Tabs>
+
+<PluginPermissions plugin="clipboard-manager" />

src/content/docs/plugin/deep-linking.mdx

@@ -10,6 +10,7 @@ sidebar:
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="deep-link" />
 
@@ -226,8 +227,4 @@ See the [Capabilities Overview](/security/capabilities/) for more information an
 }
 ```
 
-| Permission                    | Description                                                       |
-| ----------------------------- | ----------------------------------------------------------------- |
-| `deep-link:default`           | Allows reading the opened deep link via the get_current command.  |
-| `deep-link:allow-get-current` | Enables the get_current command without any pre-configured scope. |
-| `deep-link:deny-get-current`  | Denies the get_current command without any pre-configured scope.  |
+<PluginPermissions plugin="deep-link" />

src/content/docs/plugin/dialog.mdx

@@ -9,6 +9,7 @@ tableOfContents:
 import PluginLinks from '@components/PluginLinks.astro';
 import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
 import CommandTabs from '@components/CommandTabs.astro';
+import PluginPermissions from '@components/PluginPermissions.astro';
 
 <PluginLinks plugin="dialog" />
 
@@ -304,3 +305,5 @@ app.dialog()
         // return a file_path `Option`, or `None` if the user closes the dialog
     });
 ```
+
+<PluginPermissions plugin="dialog" />