feat(api): Expose application metadata and functions to JS api - fix #1387 (#1445)

Author: lemarier

.changes/js-app-metadata.md

@@ -0,0 +1,6 @@
+---
+"tauri-api": minor
+"tauri": minor
+---
+
+Added new Javascript API to extract `name`, `version`, `tauri version` from the running application. We exposed `relaunch` and `exit` as well to control your application state.

api/package.json

@@ -5,6 +5,7 @@
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",
+    "./app": "./dist/app.js",
     "./cli": "./dist/cli.js",
     "./dialog": "./dist/dialog.js",
     "./event": "./dist/event.js",

api/rollup.config.js

@@ -10,6 +10,7 @@ import pkg from './package.json'
 export default [
   {
     input: {
+      app: './src/app.ts',
       fs: './src/fs.ts',
       path: './src/path.ts',
       dialog: './src/dialog.ts',

api/src/app.ts

@@ -0,0 +1,80 @@
+import { invokeTauriCommand } from './helpers/tauri'
+
+/**
+ * @name getVersion
+ * @description Get application version
+ * @returns {Promise<string>} Promise resolving to application version
+ */
+async function getVersion(): Promise<string> {
+  return invokeTauriCommand<string>({
+    __tauriModule: 'App',
+    mainThread: true,
+    message: {
+      cmd: 'getAppVersion'
+    }
+  })
+}
+
+/**
+ * @name getName
+ * @description Get application name
+ * @returns {Promise<string>} Promise resolving to application name
+ */
+async function getName(): Promise<string> {
+  return invokeTauriCommand<string>({
+    __tauriModule: 'App',
+    mainThread: true,
+    message: {
+      cmd: 'getAppName'
+    }
+  })
+}
+
+/**
+ * @name getTauriVersion
+ * @description Get tauri version
+ * @returns {Promise<string>} Promise resolving to tauri version
+ */
+async function getTauriVersion(): Promise<string> {
+  return invokeTauriCommand<string>({
+    __tauriModule: 'App',
+    mainThread: true,
+    message: {
+      cmd: 'getTauriVersion'
+    }
+  })
+}
+
+/**
+ * @name exit
+ * @description Exits immediately with exitCode.
+ * @param [exitCode] defaults to 0.
+ * @returns {Promise<void>} Application is closing, nothing is returned
+ */
+async function exit(exitCode: Number = 0): Promise<void> {
+  return invokeTauriCommand<string>({
+    __tauriModule: 'App',
+    mainThread: true,
+    message: {
+      cmd: 'exit',
+      exitCode
+    }
+  })
+}
+
+/**
+ * @name relaunch
+ * @description Relaunches the app when current instance exits.
+ * @returns {Promise<void>} Application is restarting, nothing is returned
+ */
+async function relaunch(): Promise<void> {
+  return invokeTauriCommand<string>({
+    __tauriModule: 'App',
+    mainThread: true,
+    message: {
+      cmd: 'relaunch'
+    }
+  })
+}
+
+export { getName, getVersion, getTauriVersion, relaunch, exit }

api/src/bundle.ts

@@ -1,4 +1,5 @@
 import 'regenerator-runtime/runtime'
+import * as app from './app'
 import * as cli from './cli'
 import * as dialog from './dialog'
 import * as event from './event'
@@ -13,6 +14,7 @@ import * as notification from './notification'
 import * as globalShortcut from './globalShortcut'
 
 export {
+  app,
   cli,
   dialog,
   event,