[docs][core] Added README and API types

README.md

@@ -0,0 +1,13 @@
+# Flaschengeist `users` fontend-plugin
+
+This package provides the [Flaschengeist](https://flaschengeist.dev/Flaschengeist/flaschengeist) frontend for the `balance` plugin.
+
+## License
+
+Licensed under the MIT license, see [LICENSE](./LICENSE) for more details.
+
+## Development
+
+Feel free to report bugs, issues and feature requests using the [Issues function](https://flaschengeist.dev/Flaschengeist/flaschengeist/issues).
+
+Please follow our [general development guide](https://flaschengeist.dev/Flaschengeist/flaschengeist/wiki/Development#general-development).

package.json

@@ -1,9 +1,8 @@
 {
-    "private": true,
     "license": "MIT",
     "version": "1.0.0-alpha.1",
     "name": "@flaschengeist/balance",
-    "author": "Ferdinand <rpm@fthiessen.de>",
+    "author": "Ferdinand Thiessen <rpm@fthiessen.de>",
     "homepage": "https://flaschengeist.dev/Flaschengeist",
     "description": "Flaschengeist balance plugin",
     "bugs": {
@@ -14,24 +13,24 @@
       "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-balance"
     },
     "main": "src/index.ts",
+    "types": "src/api.d.ts",
     "scripts": {
-      "valid": "tsc --noEmit",
       "pretty": "prettier --config ./package.json  --write '{,!(node_modules)/**/}*.ts'",
       "lint": "eslint --ext .js,.ts,.vue ./src"
     },
     "devDependencies": {
-      "@flaschengeist/types": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-types.git#develop",
+      "@flaschengeist/types": "^1.0.0-alpha.1",
       "@quasar/app": "^3.0.0-beta.25",
-      "axios": "^0.21.1",
-      "prettier": "^2.3.0",
-      "typescript": "^4.2.4",
-      "pinia": "^2.0.0-alpha.19",
-      "quasar": "^2.0.0-beta.18",
       "@typescript-eslint/eslint-plugin": "^4.24.0",
       "@typescript-eslint/parser": "^4.24.0",
+      "axios": "^0.21.1",
       "eslint": "^7.26.0",
       "eslint-config-prettier": "^8.3.0",
-      "eslint-plugin-vue": "^7.9.0"
+      "eslint-plugin-vue": "^7.9.0",
+      "pinia": "^2.0.0-alpha.19",
+      "prettier": "^2.3.0",
+      "quasar": "^2.0.0-beta.18",
+      "typescript": "^4.2.4"
     },
     "peerDependencies": {
       "@flaschengeist/api": "1.0.0-alpha.1",
@@ -40,7 +39,7 @@
     "prettier": {
       "singleQuote": true,
       "semi": true,
-      "printWidth": 100,
+      "printWidth": 120,
       "arrowParens": "always"
     }
   }

src/api.d.ts

@@ -0,0 +1,12 @@
+declare namespace FG {
+	interface Transaction {
+		id: number;
+		time: Date;
+		amount: number;
+		reversal_id?: number;
+		author_id?: string;
+		sender_id?: string;
+		original_id?: number;
+		receiver_id?: string;
+	}
+}