@zean-chat/js 0.1.1 → 0.1.3

package/README.md

@@ -9,12 +9,16 @@ npm install @zean-chat/js
 ```js
 import { loadZean } from "@zean-chat/js";
 
-const zean = loadZean({ appKey: "app_your_app_key" });
+const zean = loadZean({
+  appKey: "app_your_app_key",
+  // Once the person is signed in on your side. Only `id` is required.
+  user: { id: "1042", name: "Awa Diallo", email: "awa@example.com" }
+});
 zean.open();
 zean.onUnreadChange(count => console.log(count));
 ```
 
-Methods: `open`, `close`, `toggle`, `getUnreadCount`, `onUnreadChange`, `identify(getToken)`, `signOut`, `setAttributes`. They can be called before the chat has loaded. Full guide: [install the chat on a website](https://zean.chat/docs/install-website), [JavaScript reference](https://zean.chat/docs/reference-js).
+Methods: `open`, `close`, `toggle`, `getUnreadCount`, `onUnreadChange`, `identify(user)`, `signOut`, `setAttributes`. They can be called before the chat has loaded. Full guide: [install the chat on a website](https://zean.chat/docs/install-website), [JavaScript reference](https://zean.chat/docs/reference-js).
 
 ## Why Zean
 

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export type { ZeanApi, ZeanAttributeValue, ZeanAttributes, ZeanLocale, ZeanOptions, ZeanSettings, ZeanTokenSource } from './interfaces.js';
+export type { ZeanApi, ZeanAttributeValue, ZeanAttributes, ZeanLocale, ZeanOptions, ZeanSettings, ZeanUser } from './interfaces.js';
 export { loadZean, zean } from './load.js';

package/dist/index.js

@@ -1,6 +1,14 @@
 // ../shared/src/constants/app.ts
 var APP_NAME = "Zean";
 var PRODUCTION_LOADER_URL = "https://widget.zean.chat/loader.js";
+var STAGING_APP_KEY_PREFIX = "app_stg_";
+var STAGING_LOADER_URL = "https://widget-stg.zean.chat/loader.js";
+
+// ../shared/src/utils/app-keys.ts
+var isStagingKey = (appKey) => appKey.startsWith(STAGING_APP_KEY_PREFIX);
+function loaderUrlFor(appKey) {
+  return isStagingKey(appKey) ? STAGING_LOADER_URL : PRODUCTION_LOADER_URL;
+}
 
 // src/load.ts
 var SCRIPT_ATTRIBUTE = "data-zean-sdk";
@@ -44,11 +52,11 @@ var zean = {
       stop?.();
     };
   },
-  identify: (getToken) => withApi((api) => api.identify(getToken)),
+  identify: (user) => withApi((api) => api.identify(user)),
   signOut: () => withApi((api) => api.signOut()),
   setAttributes: (attributes) => withApi((api) => api.setAttributes(attributes))
 };
-function loadZean({ appKey, getToken, locale, loaderUrl = PRODUCTION_LOADER_URL }) {
+function loadZean({ appKey, user, locale, loaderUrl = loaderUrlFor(appKey) }) {
   if (typeof window === "undefined" || typeof document === "undefined") return zean;
   if (loadedKey !== null) {
     if (loadedKey !== appKey) console.warn(`${APP_NAME}: the chat is already loaded with the App key ${loadedKey}.`);
@@ -57,10 +65,10 @@ function loadZean({ appKey, getToken, locale, loaderUrl = PRODUCTION_LOADER_URL
   loadedKey = appKey;
   if (window.zean || document.querySelector(`script[${SCRIPT_ATTRIBUTE}]`)) {
     waitForOtherLoader();
-    if (getToken) zean.identify(getToken);
+    if (user) zean.identify(user);
     return zean;
   }
-  window.zean = { appKey, ...getToken ? { getToken } : {}, ...locale ? { locale } : {} };
+  window.zean = { appKey, ...user ? { user } : {}, ...locale ? { locale } : {} };
   const script = document.createElement("script");
   script.async = true;
   script.src = loaderUrl;

package/dist/interfaces.d.ts

@@ -1,14 +1,22 @@
-/** Returns a token the Company's server signed for the signed-in person, or null when there is none. */
-export type ZeanTokenSource = () => Promise<string | null>;
 export type ZeanAttributeValue = string | number | boolean;
 /** What the page knows about the person, shown on the Contact's profile: `{ city: 'Douala', orders: 12 }`. */
 export type ZeanAttributes = Record<string, ZeanAttributeValue>;
 export type ZeanLocale = 'fr' | 'en';
+/** The person signed in to your app. Only `id` is needed; the rest shows on their Contact. */
+export interface ZeanUser {
+    /** Your own id for them: text or a number. The same id on the web and in your mobile app is one person. */
+    id: string | number;
+    name?: string;
+    email?: string;
+    phone?: string;
+    /** Their language, any one, as a tag such as `pt` or `pt-BR`. Leave it out: their device's is kept. */
+    language?: string;
+}
 /** What `window.zean` holds before the loader runs: the install code sets it. */
 export interface ZeanSettings {
     appKey: string;
-    /** For a signed-in person. Same as calling `identify` once loaded. */
-    getToken?: ZeanTokenSource;
+    /** The signed-in person. Same as calling `identify` once loaded. */
+    user?: ZeanUser;
     /** The chat's language. Leave it out: the Contact's browser's, when the chat speaks it, else the App's default. */
     locale?: ZeanLocale;
 }
@@ -20,14 +28,21 @@ export interface ZeanApi {
     getUnreadCount: () => number;
     /** Called with each new count of replies the Contact has not seen. Returns the way to stop. */
     onUnreadChange: (listener: (count: number) => void) => () => void;
-    /** The person signed in: `getToken` is called now and whenever the token expires. */
-    identify: (getToken: ZeanTokenSource) => void;
+    /**
+     * The person signed in. The first device to bring their id joins their Conversation at once; another device asks
+     * them for a code emailed to them first. Details that do not fit are left out, and the console says why.
+     */
+    identify: (user: ZeanUser) => void;
     /** The person signed out: the chat starts over, anonymous. */
     signOut: () => void;
     /** Joined to what was set before. Values the chat cannot keep are refused, and the console says why. */
     setAttributes: (attributes: ZeanAttributes) => void;
 }
 export interface ZeanOptions extends ZeanSettings {
-    /** Where the chat loads from. Leave it out: the default is Zean's own. */
+    /**
+     * Where the chat loads from. Leave it out: the App key says which of Zean's own. For local development only, so
+     * left out of the documentation.
+     * @internal
+     */
     loaderUrl?: string;
 }

package/dist/load.d.ts

@@ -10,4 +10,4 @@ export declare const zean: ZeanApi;
  * Shows the chat on the page: adds the hosted loader once, whatever the number of calls. Does nothing on the server,
  * so it is safe in code that also renders there.
  */
-export declare function loadZean({ appKey, getToken, locale, loaderUrl }: ZeanOptions): ZeanApi;
+export declare function loadZean({ appKey, user, locale, loaderUrl }: ZeanOptions): ZeanApi;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zean-chat/js",
-	"version": "0.1.1",
+	"version": "0.1.3",
 	"description": "Live chat widget for any website: add a free customer support chat in one line. Vanilla JS, TypeScript, no framework needed. Intercom and Crisp alternative.",
 	"keywords": [
 		"javascript",