Embedded version into API (#88)

* Embedded version into API

* Updated version and revision to match PCUI standard

Author: kpal81xd

eslint.config.mjs

@@ -6,7 +6,7 @@ import globals from 'globals';
 export default [
     ...playcanvasConfig,
     {
-        files: ['**/*.ts'],
+        files: ['**/*.ts', '**/*.mjs'],
         languageOptions: {
             ecmaVersion: 2022,
             sourceType: 'module',

package-lock.json

@@ -36,6 +36,7 @@
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^6.0.2",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/sharedb": "^3.2.1",
     "@typescript-eslint/parser": "^8.19.1",

package.json

@@ -1,12 +1,46 @@
+import { execSync } from 'child_process';
+import fs from 'fs';
+
 import { babel } from '@rollup/plugin-babel';
 import commonjs from '@rollup/plugin-commonjs';
 import resolve from '@rollup/plugin-node-resolve';
+import replace from '@rollup/plugin-replace';
 import typescript from '@rollup/plugin-typescript';
 import { dts } from 'rollup-plugin-dts';
 import polyfills from 'rollup-plugin-polyfill-node';
 
 import { runTsc } from './utils/plugins/rollup-run-tsc.mjs';
 
+/**
+ * @returns {string} Version string like `1.58.0-dev`
+ */
+const getVersion = () => {
+    const text = fs.readFileSync('./package.json', 'utf8');
+    const json = JSON.parse(text);
+    return json.version;
+};
+
+/**
+ * @returns {string} Revision string like `644d08d39` (9 digits/chars).
+ */
+const getRevision = () => {
+    let revision;
+    try {
+        revision = execSync('git rev-parse --short HEAD').toString().trim();
+    } catch (e) {
+        revision = 'unknown';
+    }
+    return revision;
+};
+
+const replacements = {
+    values: {
+        'PACKAGE_VERSION': getVersion(),
+        'PACKAGE_REVISION': getRevision()
+    },
+    preventAssignment: true
+};
+
 const umd = {
     external: ['@playcanvas/observer'],
     input: 'src/index.ts',
@@ -22,6 +56,7 @@ const umd = {
         typescript({
             sourceMap: false
         }),
+        replace(replacements),
         commonjs(),
         polyfills(),
         resolve(),
@@ -61,6 +96,7 @@ const module = {
         typescript({
             sourceMap: false
         }),
+        replace(replacements),
         commonjs(),
         polyfills(),
         resolve()

rollup.config.mjs

@@ -42,3 +42,13 @@ export * from './jobs';
 export * from './localstorage';
 export * from './clipboard';
 export * from './rest';
+
+/**
+ * The version of the Editor API library. This is a string in semantic version format of `major.minor.patch`.
+ */
+export const version = 'PACKAGE_VERSION';
+
+/**
+ * The git revision of the Editor API library. This is a string of the git commit hash.
+ */
+export const revision = 'PACKAGE_REVISION';