@chatsystem/client 1.0.10 → 1.0.12

package/README.md

@@ -1,7 +1,24 @@
-### Env
+# Use the client
 
-- Needed env variables are defined in `src/config/env.ts`
+## Use it as a react package
 
-### Bug pour plus tard
+- ```js
+  import { App } from "@chatsystem/client";
+  <App appToken="YOUR_TOKEN_ID" displayMode="chatbox" />;
+  ```
 
-- Si envie d'utiliser des alias pour les paths, i lfaut les mettre dans `ts-config.json` + `vite.config.ts` mais ça plante dans le build à cause de vite-dts (https://github.com/qmhc/vite-plugin-dts/issues/60) => il y a une config qui doit marcher, à fouiller si envie
+## Use it as a bundled JS script
+
+- ```js
+  <script
+    type="text/javascript"
+    src="https://chatsystem.s3.eu-west-3.amazonaws.com/index.js"
+    data-appToken="YOUR_TOKEN_ID"
+    data-displayMode="chatbox"
+  ></script>
+  ```
+
+### Env variable
+
+- appToken: your appToken, delivered on chatsystem.ai
+- displayMode?: either `bubble` if you want the bubble to display, or `chatbox` if you want to see directly the chatbox. Css is overridable.

package/dist/index.d.ts

@@ -4,9 +4,14 @@ export declare function App({ appToken, displayMode }: AppProps): JSX_2.Element;
 
 declare type AppProps = {
     appToken: string;
-    displayMode?: DisplayModeTypes;
+    displayMode?: DisplayModesTypes;
 };
 
-declare type DisplayModeTypes = "bubble" | "chatbox";
+declare enum DisplayModeEnum {
+    BUBBLE = "bubble",
+    CHATBOX = "chatbox"
+}
+
+declare type DisplayModesTypes = `${DisplayModeEnum}`;
 
 export { }