feat: Unified Version and added semver checking

.editorconfig

@@ -3,6 +3,6 @@ charset = utf-8
 insert_final_newline = true
 end_of_line = lf
 
-[*.{js,ts,tsx,rs}]
+[*.{json,js,ts,tsx,rs}]
 indent_size = 4
 indent_style = tab

.github/workflows/build.yml

@@ -73,10 +73,7 @@ jobs:
       env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
       run: |
-        echo "`jq \".version+=\\\"-$(git rev-parse --short HEAD)\\\"\" package.json`" > package.json && \
+        echo "-$(git rev-parse --short HEAD)" >> version && \
         pnpm install && \
         pnpm build && \
         pnpm publish --no-git-checks --tag prerelease
-     
-
-

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

backend/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "backend"
-version = "0.9.7"
+version = "0.0.0"
 edition = "2021"
 license = "GPL-2.0"
 authors = ["Christopher-Robin Ebbinghaus <[email protected]>"]

backend/src/env.rs

@@ -4,7 +4,7 @@ use std::path::Path;
 pub const PORT: u16 = 12412; // TODO replace with something unique
 
 pub const PACKAGE_NAME: &'static str = env!("CARGO_PKG_NAME");
-pub const PACKAGE_VERSION: &'static str = env!("CARGO_PKG_VERSION");
+pub const PACKAGE_VERSION: &'static str = include_str!("../../version");
 pub const PACKAGE_AUTHORS: &'static str = env!("CARGO_PKG_AUTHORS");
 
 const TEMPDIR: &'static str = "/tmp/MicroSDeck";

lib/.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

lib/package.json

@@ -1,30 +1,34 @@
 {
-  "name": "@cebbinghaus/microsdeck",
-  "version": "0.9.7",
-  "description": "",
-  "keywords": [],
-  "author": "CEbbinghaus",
-  "license": "GPLv2",
-
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "watch": "tsc -w"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/CEbbinghaus/MicroSDeck.git",
-    "directory": "src/lib"
-  },
-  "devDependencies": {
-    "@types/react": "16.14.0",
-    "lipe": "^0.3.3"
-  },
-  "dependencies": {
-    "typescript": "^4.9.5"
-  }
+	"name": "@cebbinghaus/microsdeck",
+	"version": "0.0.0",
+	"description": "",
+	"keywords": [],
+	"author": "CEbbinghaus",
+	"license": "GPLv2",
+	"main": "dist/index.js",
+	"typings": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"prebuild": "node ../util/updateVersion.js",
+		"build": "tsc",
+		"postbuild": "node ../util/resetVersion.js",
+		"watch": "tsc -w",
+		"prepack": "node ../util/updateVersion.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/CEbbinghaus/MicroSDeck.git",
+		"directory": "src/lib"
+	},
+	"devDependencies": {
+		"@types/react": "16.14.0",
+		"@types/semver": "^7.5.6",
+		"lipe": "^0.3.3",
+		"typescript": "^4.9.5"
+	},
+	"dependencies": {
+		"semver": "^7.5.4"
+	}
 }

lib/src/MicoSDeck.ts

@@ -2,6 +2,11 @@ import { Event as BackendEvent, EventType, fetchCardsAndGames, fetchCardsForGame
 import Logger from "lipe";
 import { CardAndGames, CardsAndGames, MicroSDCard } from "./types.js"
 
+import semverParse from "semver/functions/parse"
+import semverEq from "semver/functions/eq.js"
+
+import { version } from "../package.json"
+
 function sleep(ms: number): Promise<void> {
 	return new Promise(resolve => setTimeout(() => resolve(), ms));
 }
@@ -20,6 +25,36 @@ export type EventBus<K extends string, T extends Event> = {
 	removeEventListener(type: K, callback: EventBusListener<T> | EventBusListenerObject<T> | null, options?: boolean | EventListenerOptions | undefined): void;
 }
 
+export { version };
+
+/**
+ * Matches the current MicroSDeck version against the version provided.
+ * Returns true if the semver matches and compatibility is guaranteed. 
+ * @export
+ * @param {string} version1 his should be in valid semver notation of x.y.z
+ * @param {string} version2 This should be in valid semver notation of x.y.z
+ */
+export function IsMatchingSemver(version1: string, version2: string, strict: boolean = false): boolean {
+	const semVersion1 = semverParse(version1) ?? (() => {throw new Error("Current Version is not a valid Semver. (How did we get here?)")})();
+	const semVersion2 = semverParse(version2) ?? (() => {throw new Error("provided Version is not a valid Semver.")})();;
+
+	// the two major versions do not match. Not valid
+	if(semVersion1.major != semVersion2.major && semVersion1.major != 0) {
+		return false;
+	}
+
+	// The minor version can introduce breaking changes while <1.0
+	if(semVersion1.minor != semVersion2.minor &&  semVersion1.major == 0) {
+		return false;
+	}
+
+	if(!strict) {
+		return true;
+	}
+
+	return semverEq(semVersion1, semVersion2);
+}
+
 export class MicroSDeck {
 	private abortController = new AbortController();
 
@@ -28,11 +63,20 @@ export class MicroSDeck {
 
 	public eventBus = new EventTarget() as unknown as EventBus<EventType, Event | CustomEvent<BackendEvent>>;
 
+	public get Version() {
+		return version;
+	}
+
 	private enabled: boolean = false;
 	public get Enabled() {
 		return this.enabled;
 	}
-	private version: string | undefined;
+
+	private backendVersion: string | undefined;
+	public get BackendVersion() {
+		return this.backendVersion;
+	}
+
 	private currentCardAndGames: CardAndGames | undefined;
 	public get CurrentCardAndGames() {
 		return this.currentCardAndGames;
@@ -62,18 +106,23 @@ export class MicroSDeck {
 	destruct() {
 		this.logger?.Debug("Deconstruct Called");
 		if (this.isDestructed) return;
-		this.isDestructed = true;
 		this.logger?.Log("Deinitializing MicroSDeck");
 		this.abortController.abort("destruct");
+		this.isDestructed = true;
 	}
 
 	async fetch() {
-		this.enabled = await fetchHealth(this.fetchProps);
-		this.version = await fetchVersion(this.fetchProps);
+		if(!await fetchHealth(this.fetchProps)) {
+			this.enabled = false;
+			this.logger?.Log("Fetch failed. Server is offline...");
+			return;
+		}
+		this.backendVersion = await fetchVersion(this.fetchProps);
 
 		await this.fetchCurrent();
 		await this.fetchCardsAndGames();
 		this.eventBus.dispatchEvent(new Event("update"));
+		this.enabled = true;
 	}
 
 	async fetchCurrent() {
@@ -86,7 +135,7 @@ export class MicroSDeck {
 	getProps() {
 		return {
 			enabled: this.enabled,
-			version: this.version,
+			version: this.backendVersion,
 			cardsAndGames: this.cardsAndGames,
 			currentCardAndGames: this.currentCardAndGames
 		}

lib/tsconfig.json

@@ -6,6 +6,7 @@
     "jsx": "react",
     "jsxFactory": "window.SP_REACT.createElement",
     "jsxFragmentFactory": "React.Fragment",
+    "allowJs": true,
     "declaration": true,
     "moduleResolution": "Node",
     "noUnusedLocals": true,
@@ -18,7 +19,8 @@
     "ignoreDeprecations": "5.0",
     "suppressImplicitAnyIndexErrors": true,
     "allowSyntheticDefaultImports": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "resolveJsonModule": true
   },
   "include": ["src"],
   "exclude": ["node_modules"]