@ututrust/web-components 2.3.0-alpha.8 → 2.3.1

package/README.md

@@ -24,15 +24,16 @@ $ npm install @ututrust/web-components
 
 ## Configuration options 
 
-The SDK can be configured by dispatching an `utuConfig` event. It 
-currently supports only one element: `production` (`boolean`).
+The SDK can be configured by calling a function on the SDK to inform it what the environment is so 
+that the SDK talks to the correct endpoints:
 
-If set to `true`, the SDK will connect to UTU's production API services. 
-Otherwise (default), it will connect to UTU API testing services.
-
-Use it like so, after the SDK has been loaded:
 ```
-window.dispatchEvent(new CustomEvent("utuConfig", { detail: { production: true } }));
+const config: IConfig = {
+      production,
+      provider: walletProvider
+    };
+
+updateConfig(config);
 ```
 
 ## Examples
@@ -224,6 +225,20 @@ To mock an UTU API response, specify ```api-url``` of ```<x-utu-root>```:
 
 Example of a JSON file can be find at ```/packages/utu-web-components/src/api-mock```
 
+## Using / Not using Unlock
+
+Unlock is a library that allows us to charge for access to signal.  The SDK can be built / run with unlock integrated or not integrated.  This is controlled by an .env file.
+
+Please copy .env_example and rename it to .env
+
+Inside the .env file it has:
+
+```
+VITE_USE_UNLOCK=false
+```
+
+If you want to use Unlock set the above variable to true
+
 ## Local Development
 Development stack:
 - [preactjs](https://preactjs.com)
@@ -247,13 +262,30 @@ Install dependencies
 $ npm install
 ```
 
-Start watch mode with preview in a browser
+Start watch mode with preview in a browser.
 
 ```bash
-$ npm start
+$ npm run dev
+```
+To mock out talking to the UTU backend run this command in another terminal window:
+
+```
+npm run api-mock
+```
+
+To mock out the video recording make sure you are in this directory:
+
+```
+<project-dir>/packages/video-server-mock
+```
+
+and run this command in another terminal window:
+
+```
+npm run start
 ```
 
-Production build
+To test that there are no compilation issues in the Production build run:
 
 ```bash
 $ npm run build
@@ -282,3 +314,90 @@ This will generate a ```.tgz``` file at the directory’s root with a structure
 ```bash
 $ npm install <path to the package>/utu-web-components-1.0.0.tgz
 ```
+
+## 🚀Release Workflow
+
+We maintain **two types of releases** for the SDK:
+
+- **Production release** → `UnlockGateway` **enabled**
+- **Staging release** → `UnlockGateway` **commented out**
+
+---
+
+### 🔹Production Release
+
+```bash
+# make sure main is up to date
+git checkout main
+git pull
+
+# create + switch to a release branch
+git checkout -b release-[version]
+
+```
+
+➡️ To get  `FeedbackDetails.tsx` to NOT use Unlock for showing feedback you need to set the .env file to have this attribute:
+
+```
+VITE_USE_UNLOCK=false
+```
+
+Internally it will not inject the UnlockGateway tags
+
+Note that Unlock functionality is about the user paying to see Signal.
+
+➡️ In `package.json`
+
+Update the release version number (e.g. `1.2.3`)
+
+```bash
+git add .
+git commit -m "Production release: enabled UnlockGateway + version bump"
+git push origin release-[version]
+
+# build + publish production
+npm run build
+npm login
+npm publish
+
+```
+
+---
+
+### 🔹Staging Release
+
+```bash
+# back to main
+git checkout main
+git pull
+
+# create + switch to a staging branch
+git checkout -b release-[version]-alpha
+```
+
+➡️ To get  `FeedbackDetails.tsx` to use Unlock for showing feedback you need to set the .env file to have this attribute:
+
+```
+VITE_USE_UNLOCK=true
+```
+
+Internally it will inject the UnlockGateway tags
+
+Note that Unlock functionality is about the user paying to see Signal.
+
+
+➡️ In `package.json`
+
+Update the version number with an alpha tag (e.g. `1.2.3-alpha.0`)
+
+```bash
+git add .
+git commit -m "Staging release: commented UnlockGateway + version bump"
+git push origin release-[version]-alpha
+
+# build + publish staging
+npm run build
+npm login
+npm publish
+
+```