@iebh/tera-fy 1.7.4 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+# [1.9.0](https://github.com/IEBH/TERA-fy/compare/v1.8.0...v1.9.0) (2024-06-06)
+
+
+### Features
+
+* **proxy:** Better in-use port detection + custom logging handler ([8bfa2d3](https://github.com/IEBH/TERA-fy/commit/8bfa2d3923ef8a71dff04983113eca0b8cff606f))
+
+# [1.8.0](https://github.com/IEBH/TERA-fy/compare/v1.7.4...v1.8.0) (2024-06-04)
+
+
+### Bug Fixes
+
+* Remove secondary /project path segment when computing ProjectFile.teraUrl ([18ad085](https://github.com/IEBH/TERA-fy/commit/18ad085e77df9e9c1e5deb4a84f5d888df6255c3))
+* Updated default port to match TERA proxy deployment ([6904dfc](https://github.com/IEBH/TERA-fy/commit/6904dfcf4505a2989733e5a46537ef140aedadea))
+
+
+### Features
+
+* Add stub for uiProgress (unfinished implementation) ([402d181](https://github.com/IEBH/TERA-fy/commit/402d1810fb679782088728958140304cb0eba9c9))
+* Added plugins/vite ([3d48f3b](https://github.com/IEBH/TERA-fy/commit/3d48f3b7a2c52648f5757d267606dec9800d08a0))
+* More init debug steps + transmit server verbosity as first action ([8cb6e52](https://github.com/IEBH/TERA-fy/commit/8cb6e5221883079158af508be552eea7055fedc2))
+* setServerVerbosity() ([a0f7f77](https://github.com/IEBH/TERA-fy/commit/a0f7f77d7c95e43a1cea0f73fb199a513a561b55))
+* toggleDevMode() now also accepts the "proxy" meta value to switch to local proxy-forwarding mode ([d2fa61d](https://github.com/IEBH/TERA-fy/commit/d2fa61d6c584a7489ea18b3f48d28e5ab91cf682))
+
 ## [1.7.4](https://github.com/IEBH/TERA-fy/compare/v1.7.3...v1.7.4) (2024-05-31)
 
 

package/README.md

@@ -47,3 +47,51 @@ Generally importing the source code TERA-fy client (`import terafy from '@iebh/t
 | `@iebh/tera-fy/dist/plugin.vue2.es2019.js` | ESM + ES2019 | `@vue/cli-service` compatible version of the Vue@2 plugin          |
 
 More versions can be added upon request or PR of the build command in the scripts section of `package.json`.
+
+
+Plugins
+=======
+This module exports various plugins which are availble as `import from '@iebh/tera-fy/plugins/*'`.
+
+
+`@iebh/tera-fy/plugins/vue2`
+----------------------------
+FIXME: To add documentation
+
+
+`@iebh/tera-fy/plugins/vue3`
+----------------------------
+FIXME: To add documentation
+
+
+`@iebh/tera-fy/plugins/vite`
+----------------------------
+A plugin for Vite which boots a local proxy server to route traffic to/from `localhost:7334` to tera-tools.com.
+This is to work around the issue where a local website is usually forbidden from talking to TERA-tools.com unless its running with a HTTPS context.
+
+Example Usage within `vite.config.js`:
+
+```javascript
+// ... Other imports ... //
+import pluginTeraFy from '@iebh/tera-fy/plugins/vite';
+
+export default {
+	plugins: [
+		// ... other plugin config ... //
+
+		pluginTeraFy(), // ... or add an options object to override the defaults
+	],
+}
+```
+
+Configuration options:
+
+| Option           | Type      | Default            | Description                                                    |
+|------------------|-----------|--------------------|----------------------------------------------------------------|
+| `force`          | `Boolean` | `false`            | Restart the server even if its apparently running              |
+| `autoStart`      | `Boolean` | `true`             | Automatically start the proxy without calling `Plugin.start()` |
+| `host`           | `String`  | `'0.0.0.0'`        | Host IP to listen on                                           |
+| `port`           | `Number`  | `7334`             | Host port to listen on                                         |
+| `targetProtocol` | `String`  | `'https'`          | Target protocol to forward to                                  |
+| `targetHost`     | `String`  | `'tera-tools.com'` | Target host to forward to                                      |
+| `targetPort`     | `Number`  | `443`              | Target port to forward to                                      |