fix typos & improve error messages

Author: marcomq

.gitignore

@@ -14,3 +14,5 @@ Cargo.lock
 node_modules/
 
 dist
+dist-js
+!dist-js/*.iife.js

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tauri-plugin-python"
-version = "0.3.4"
+version = "0.3.5"
 authors = [ "Marco Mengelkoch" ]
 description = "A tauri 2 plugin to use python code in the backend."
 keywords = ["rust", "python", "tauri", "gui"]

README.md

@@ -12,7 +12,7 @@ which can be complicated, especially for mobile targets.
 
 The plugin reads by default the file `src-tauri/src-python/main.py` during 
 startup and runs it immediately. Make sure to add all your python source as tauri resource,
-so it is shipped together with your productioon binaries. Python functions are all registered during plugin initialization 
+so it is shipped together with your production binaries. Python functions are all registered during plugin initialization 
 and can get called during application workflow.
 
 
@@ -58,11 +58,10 @@ Javascript in [examples/plain-javascript](https://github.com/marcomq/tauri-plugi
 
 ## Add the plugin to an existing tauri application
 
-
 These steps assume that you already have a basic tauri application available. Alternatively, you can immediately start with the application in "example" directory.
 
 - run `npm run tauri add python`
-- add `src-tauri/src-python/main.py` and modify it acording to your needs, for example add 
+- add `src-tauri/src-python/main.py` and modify it according to your needs, for example add 
 ```python
 # src-tauri/src-python/main.py
 _tauri_plugin_functions = ["greet_python"] # make "greet_python" callable from UI

dist-js/index.cjs

@@ -1,5 +1,5 @@
 if ('__TAURI__' in window) {
-var __TAURI_PYTHON_PLUGIN_API__ = (function (exports) {
+var __TAURI_PLUGIN_PYTHON_API__ = (function (exports) {
     'use strict';
 
     /******************************************************************************
@@ -46,7 +46,7 @@ var __TAURI_PYTHON_PLUGIN_API__ = (function (exports) {
     /** Tauri Python Plugin
      * © Copyright 2024, by Marco Mengelkoch
      * Licensed under MIT License, see License file for more details
-     * git clonehttps://github.com/marcomq/tauri-plugin-python
+     * git clone https://github.com/marcomq/tauri-plugin-python
     **/
     let call = {}; // array of functions
     async function runPython(code) {
@@ -59,10 +59,10 @@ var __TAURI_PYTHON_PLUGIN_API__ = (function (exports) {
         });
     }
     /**
-     * Regeisters function on server and makes it available via `call.{jsFunctionName}`
+     * Registers function on server and makes it available via `call.{jsFunctionName}`
      *  @param {string} pythonFunctionCall - The python function call, can contain one dot
-     *  @param {number} [numberOfArgs] - Number of arguments, used for validation in pythons, use -1 to ignore this value
-     *  @param {string} [jsFunctionName] - Name that is used in javscript: "call.jsFunctionName". Must not contain dots.
+     *  @param {number} [numberOfArgs] - Number of arguments, used for validation in python, use -1 to ignore this value
+     *  @param {string} [jsFunctionName] - Name that is used in javascript: "call.jsFunctionName". Must not contain dots.
      */
     async function registerFunction(pythonFunctionCall, numberOfArgs, jsFunctionName) {
         if (numberOfArgs !== undefined && numberOfArgs < 0) {
@@ -82,7 +82,7 @@ var __TAURI_PYTHON_PLUGIN_API__ = (function (exports) {
      * No server invokation - assumes that function has already been registered server-side
      * Makes function available as `call.{jsFunctionName}`
      *  @param {string} pythonFunctionCall - The python function call, can contain one dot
-     *  @param {string} [jsFunctionName] - Name that is used in javscript: "call.jsFunctionName". Must not contain dots.
+     *  @param {string} [jsFunctionName] - Name that is used in javascript: "call.jsFunctionName". Must not contain dots.
      */
     async function registerJs(pythonFunctionCall, jsFunctionName) {
         if (jsFunctionName === undefined) {
@@ -126,4 +126,4 @@ var __TAURI_PYTHON_PLUGIN_API__ = (function (exports) {
     return exports;
 
 })({});
-Object.defineProperty(window.__TAURI__, 'python', { value: __TAURI_PYTHON_PLUGIN_API__ }) }
+Object.defineProperty(window.__TAURI__, 'python', { value: __TAURI_PLUGIN_PYTHON_API__ }) }

dist-js/index.d.ts

@@ -1,7 +1,7 @@
 /** Tauri Python Plugin
  * © Copyright 2024, by Marco Mengelkoch
  * Licensed under MIT License, see License file for more details
- * git clonehttps://github.com/marcomq/tauri-plugin-python
+ * git clone https://github.com/marcomq/tauri-plugin-python
 **/
 
 import { invoke } from '@tauri-apps/api/core'
@@ -19,10 +19,10 @@ export async function runPython(code: string): Promise<string> {
 }
 
 /** 
- * Regeisters function on server and makes it available via `call.{jsFunctionName}`
+ * Registers function on server and makes it available via `call.{jsFunctionName}`
  *  @param {string} pythonFunctionCall - The python function call, can contain one dot
- *  @param {number} [numberOfArgs] - Number of arguments, used for validation in pythons, use -1 to ignore this value
- *  @param {string} [jsFunctionName] - Name that is used in javscript: "call.jsFunctionName". Must not contain dots.
+ *  @param {number} [numberOfArgs] - Number of arguments, used for validation in python, use -1 to ignore this value
+ *  @param {string} [jsFunctionName] - Name that is used in javascript: "call.jsFunctionName". Must not contain dots.
  */
 export async function registerFunction(
   pythonFunctionCall: string,
@@ -42,13 +42,11 @@ export async function registerFunction(
   });
 }
 
-
-
 /** 
  * No server invokation - assumes that function has already been registered server-side
  * Makes function available as `call.{jsFunctionName}`
  *  @param {string} pythonFunctionCall - The python function call, can contain one dot
- *  @param {string} [jsFunctionName] - Name that is used in javscript: "call.jsFunctionName". Must not contain dots.
+ *  @param {string} [jsFunctionName] - Name that is used in javascript: "call.jsFunctionName". Must not contain dots.
  */
 export async function registerJs(pythonFunctionCall: string, jsFunctionName?: string) {
   if (jsFunctionName === undefined) {

dist-js/index.iife.js

@@ -1,6 +1,6 @@
 {
   "name": "tauri-plugin-python-api",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "author": "Marco Mengelkoch",
   "description": "Javascript package for tauri 2 python plugin.",
   "type": "module",

dist-js/index.js

@@ -1,15 +1,13 @@
 import { readFileSync } from 'fs'
 import { join } from 'path'
 import { cwd } from 'process'
-
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import typescript from '@rollup/plugin-typescript'
 
 const pkg = JSON.parse(readFileSync(join(cwd(), 'package.json'), 'utf8'))
 
-
 const pluginJsName = 'python' // window.__TAURI__.python
-const iifeVarName = '__TAURI_PYTHON_PLUGIN_API__'
+const iifeVarName = '__TAURI_PLUGIN_PYTHON_API__'
 
 export default [{
   input: 'guest-js/index.ts',
@@ -35,19 +33,19 @@ export default [{
     ...Object.keys(pkg.peerDependencies || {})
   ]
 },
-  {
-    input: 'guest-js/index.ts',
-    output: [
-      {
-        name: iifeVarName,
-        file: pkg.exports.html,
-        format: 'iife',
-        banner: "if ('__TAURI__' in window) {",
-        // the last `}` closes the if in the banner
-        footer: `Object.defineProperty(window.__TAURI__, '${pluginJsName}', { value: ${iifeVarName} }) }`
+{
+  input: 'guest-js/index.ts',
+  output: [
+    {
+      name: iifeVarName,
+      file: pkg.exports.html,
+      format: 'iife',
+      banner: "if ('__TAURI__' in window) {",
+      // the last `}` closes the if in the banner
+      footer: `Object.defineProperty(window.__TAURI__, '${pluginJsName}', { value: ${iifeVarName} }) }`
 
-      }
-    ],
-    plugins: [typescript(), nodeResolve()],
-  }
+    }
+  ],
+  plugins: [typescript(), nodeResolve()],
+}
 ]