@tugitark/react-widget 1.5.4 → 1.5.5

package/index.md

@@ -8,21 +8,37 @@ Also see [the original integration guide](https://www.tugitark.com/chat-setup) f
  Minimal Example
 -----------------
 
-This is the smallest number of properties that you can pass to `<TugiWidget>` and have it still operate correctly.  These properties are given to you on signing up with Tugi Tark and must be entered accurately.
+To use the Tugi Tark widget on your page, simply call the exported default component.  With no parameters given the code will try its upmost to determine the current player and brand, falling back to unauthenticated users when it can't (which will require them to verify their e-mail address and will not provide their profile to the AI Agent).
 
 ```react
 import TugiWidget from '@tugitark/react-widget';
 
-function Component(props) {
+function Component() {
+	return (
+		<TugiWidget />
+	);
+}
+```
+
+If your server has the standard `/.tugi` endpoints (as provided by our back-end libraries and documented in our [developer documentation](https://gitlab.com/tugitark/integration/docs)) this is enough to get started with the Tugi Widget.  The `/.tugi/jwt/issue` endpoint will be called with no ID given, and if that can return the data for the current player (e.g. from the HTTP session) this is enough.  Alternatively you can pass an ID explicitly:
+
+```react
+import TugiWidget from '@tugitark/react-widget';
+
+interface Props {
+	userId: string;
+}
+
+function Component(props: Props) {
 	return (
 		<TugiWidget user={props.userId} />
 	);
 }
 ```
 
-If your server has the standard `/.tugi` endpoints (as provided by our back-end libraries and documented in our [developer documentation](https://gitlab.com/tugitark/integration/docs)) this is enough to get started with the Tugi Widget.  `user` is the ID within your system of the current player.  How you determine the current player's unique ID depends entirely on your system and is left as a provided parameter here.  This is the ID that the widget will internally pass to the `/.tugi/jwt/issue` endpoint to retrieve the player's profile, and so must in some way identify an end-user on your server.  Technically even `user` is optional, and not passing this either will use the unauthenticated flow (in which the AI Agent has no information on which to base responses, and where a player will require e-mail verification first), or try to get the user's ID from the server.
+`user` is the ID within your system of the current player.  How you determine the current player's unique ID depends entirely on your system and is left as a provided parameter here.  This is the ID that the widget will internally pass to the `/.tugi/jwt/issue` endpoint to retrieve the player's profile, and so must in some way identify an end-user on your server.
 
-Calls to `render` are idempotent, if the parameter objects are equivalent.  The library will perform deep value comparisons between the parameters of two calls and only act on those that have changed.
+Calls to `<TugiWidget />` are idempotent, if the parameter objects are equivalent.  The library will perform deep value comparisons between the parameters of two calls and only act on those that have changed.
 
  Custom Example
 ----------------

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tugitark/react-widget",
-	"version": "1.5.4",
+	"version": "1.5.5",
 	"description": "Wraps the tugitark widget in a React component.",
 	"scripts": {
 		"build": "npx esbuild index.ts --target=es6 --outfile=index.js && sed -i 's/\\bconst\\b/var/g' index.js && sed -i 's/\\blet\\b/var/g' index.js && npx esbuild index.js --allow-overwrite --minify --target=es5 --outfile=index.js && npx tsc --noErrorTruncation --declaration --emitDeclarationOnly --target es6 --module nodenext --moduleResolution nodenext --outDir . index.ts"
@@ -12,7 +12,7 @@
 		"index.md"
 	],
 	"dependencies": {
-		"@tugitark/declarative-widget": "^1.3.3"
+		"@tugitark/declarative-widget": "^1.3.5"
 	},
 	"peerDependencies": {
 		"react": ">=0.0.0"