@subiz/widget-v4 4.1.213 → 4.1.215

package/dist/screenshoot.js

@@ -4586,6 +4586,8 @@ let trackResponseFn = (param, done) => {
     _defineProperty(this, "getConversation", cid => this.apireq.get(`/accounts/${this.accid}/conversations/${cid}`));
     _defineProperty(this, "getLocaleContent", locale => this.apireq.get(`/accounts/${this.accid}/languages/${locale}`));
     _defineProperty(this, "sendEvent", data => this.apireq.addQuery('shorten', true).addQuery('x-referer', util/* default */.A.get(location, 'origin', '')).post(`/accounts/${this.accid}/users/${this.uid}/events`, data));
+    _defineProperty(this, "websiteFormRequest", () => this.apireq.setBaseUrl(this.ApiURL.replace(/\/4\.[01]\/?$/, '/4.1')));
+    _defineProperty(this, "submitWebsiteForm", (formid, payload) => this.websiteFormRequest().post(`/accounts/${this.accid}/external-forms/${encodeURIComponent(formid)}/submissions`, payload));
     _defineProperty(this, "submitForm", (form_id, page_url, device, data, user) => this.apireq.addQuery('x-referer', util/* default */.A.get(location, 'origin', '')).post(`/accounts/${this.accid}/users/${this.uid}/events`, {
       by: {
         id: this.uid,
@@ -6577,6 +6579,53 @@ class Store {
       this.reconnectGate.open();
     }
   }
+  async submitWebsiteForm(formid, payload) {
+    await this.readyGate.entry();
+    const key = websiteFormStorageKey(this.api, formid);
+    const kv = this.kv;
+    const result = formResult(await this.api.submitWebsiteForm(formid, payload));
+    try {
+      kv.put(key, {
+        conversation_id: result.conversation_id,
+        expires_at: util/* default */.A.Date.now() + 7 * 24 * 60 * 60 * 1000
+      });
+    } catch (_) {}
+    return result;
+  }
+  getFormStatus(formid) {
+    const key = websiteFormStorageKey(this.api, formid);
+    try {
+      const receipt = this.kv.match(key);
+      if (!receipt) return {
+        submitted: false,
+        status: 'not_found'
+      };
+      if (!Number.isFinite(receipt.expires_at) || typeof receipt.conversation_id !== 'string' || !receipt.conversation_id) {
+        this.kv.del(key);
+        return {
+          submitted: false,
+          status: 'not_found'
+        };
+      }
+      if (receipt.expires_at <= util/* default */.A.Date.now()) {
+        this.kv.del(key);
+        return {
+          submitted: false,
+          status: 'expired'
+        };
+      }
+      return {
+        submitted: true,
+        status: 'found',
+        conversation_id: receipt.conversation_id
+      };
+    } catch (_) {
+      return {
+        submitted: false,
+        status: 'storage_unavailable'
+      };
+    }
+  }
   async submitForm(formid, data, user) {
     await this.readyGate.entry();
     if (user) await this.setUser(user);
@@ -6704,6 +6753,7 @@ class Store {
   async _onWs(ev) {
     if (this._die) return;
     if (!ev || !ev.type) return;
+    if (util/* default */.A.get(ev, 'touchpoint.channel') === 'form' || util/* default */.A.get(ev, 'data.conversation.touchpoint.channel') === 'form') return;
     ev.created = util/* default */.A.getMs(ev.created);
     if (ev.type === 'user_info_updated') {
       return;
@@ -7459,6 +7509,22 @@ var xhrsend = function (method, url, body, cb) {
   request.send(body);
 };
 const dieErr = new Error('sdk unloaded');
+function websiteFormStorageKey(api, formid) {
+  return 'sbz_form_submitted:' + util/* default */.A.stringify([api.accid, api.uid, formid]);
+}
+function formResult(response) {
+  const body = response && response.body;
+  const detail = response && response.error || body && body.error;
+  const status = response && response.code;
+  const valid = body && typeof body.conversation_id === 'string' && body.conversation_id && typeof body.submission_id === 'string' && body.submission_id;
+  if (detail || !(status >= 200 && status < 300) || !valid) {
+    const error = new Error('Subiz form request failed');
+    error.code = detail && detail.code || 'form_request_failed';
+    error.status = status;
+    throw error;
+  }
+  return body;
+}
 // EXTERNAL MODULE: ./src/common.js
 var common = __webpack_require__(2840);
 // EXTERNAL MODULE: ./node_modules/preact/dist/preact.module.js
@@ -14149,8 +14215,9 @@ class lib_Widget {
     this.impressionTokens[formid] = impressiontoken;
     return impressiontoken;
   }
-  async submitForm(formid, values) {
-    if (!formid || !values) return;
+  async submitForm(formid, values, options = {}) {
+    if (!formid || !values) throw new TypeError('submitForm requires a form ID and fields');
+    await this.store.readyGate.entry();
     if (util/* default */.A.startsWith(formid, 'cp')) {
       let storeuser = util/* default */.A.cloneDeep(this.store.matchUser());
       let user = {
@@ -14181,33 +14248,13 @@ class lib_Widget {
       this.store.setUserDiff(user);
       return this.store.sendConversion(formid, values, impressiontoken);
     }
-    values = util/* default */.A.filter(values, field => {
-      return field.key && field.value;
-    });
-    let text = 'Khách điền form\n';
-    util/* default */.A.map(values, field => {
-      text += '+ ' + field.key + ': ' + field.value + '\n';
-    });
-    return this.store.startConvo({
-      subject: 'Khách điền form',
-      touchpoint: {
-        channel: 'form',
-        source: window.location.hostname,
-        id: Date.now() + '_' + util/* default */.A.randomString()
-      },
-      form_submission: {
-        id: formid,
-        values: values
-      },
-      message_sent: {
-        data: {
-          message: {
-            format: 'plaintext',
-            text: text
-          }
-        }
-      }
-    });
+    const payload = formRequest(formid, values, options);
+    return this.store.submitWebsiteForm(formid, payload);
+  }
+  async getFormStatus(formid) {
+    validateWebsiteFormId(formid);
+    await this.store.readyGate.entry();
+    return this.store.getFormStatus(formid);
   }
   startConvo(req) {
     req = util/* default */.A.cloneDeep(req) || {};
@@ -14320,6 +14367,34 @@ class lib_Widget {
 }
 window.__sbz_WIDGET = lib_Widget;
 /* harmony default export */ const lib = (lib_Widget);
+function validateWebsiteFormId(formid) {
+  if (typeof formid !== 'string' || !/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/.test(formid)) {
+    throw new TypeError('Form ID must contain 1-64 letters, digits, underscores or hyphens');
+  }
+  if (formid.startsWith('cp')) throw new TypeError('Form IDs starting with cp are reserved for Subiz campaigns');
+}
+function formRequest(formid, fields, options = {}) {
+  validateWebsiteFormId(formid);
+  if (!Array.isArray(fields) || !fields.length) throw new TypeError('Form fields must be a nonempty array');
+  if (!options || typeof options !== 'object' || Array.isArray(options)) throw new TypeError('Form options must be an object');
+  return {
+    form_name: options.name === undefined ? formid : options.name,
+    page_url: options.page_url === undefined ? window.location.href : options.page_url,
+    submission_id: options.submission_id === undefined ? util/* default */.A.randomString(36) : options.submission_id,
+    values: fields.map(field => {
+      if (!field || typeof field.key !== 'string') throw new TypeError('Each field requires a key');
+      const value = field.value;
+      if (value != null && !['string', 'number', 'boolean'].includes(typeof value)) {
+        throw new TypeError('Form field values must be strings, numbers or booleans');
+      }
+      return {
+        key: field.key,
+        label: field.label === undefined ? field.key : field.label,
+        value: value == null ? '' : String(value)
+      };
+    })
+  };
+}
 ;// ./screenshoot.js
 
 let accid = 'acqsulrowbxiugvginhw';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@subiz/widget-v4",
-	"version": "4.1.213",
+	"version": "4.1.215",
 	"main": "./compiled_src/lib.js",
 	"scripts": {
 		"dev": "npx webpack serve --config webpack.dev.js",

package/src/lib.js

@@ -208,8 +208,9 @@ class Widget {
 	}
 
 	// cpxdf, [{key:'fullname', type:'text', value: 'thanhpk@liec.om'}]
-	async submitForm(formid, values) {
-		if (!formid || !values) return
+	async submitForm(formid, values, options = {}) {
+		if (!formid || !values) throw new TypeError('submitForm requires a form ID and fields')
+		await this.store.readyGate.entry()
 		if (sb.startsWith(formid, 'cp')) {
 			let storeuser = sb.cloneDeep(this.store.matchUser())
 			let user = {id: storeuser.id, account_id: storeuser.account_id}
@@ -233,28 +234,14 @@ class Widget {
 			return this.store.sendConversion(formid, values, impressiontoken)
 		}
 
-		values = sb.filter(values, (field) => {
-			return field.key && field.value
-		})
-		let text = 'Khách điền form\n'
-		sb.map(values, (field) => {
-			text += '+ ' + field.key + ': ' + field.value + '\n'
-		})
-
-		return this.store.startConvo({
-			subject: 'Khách điền form',
-			touchpoint: {
-				channel: 'form',
-				source: window.location.hostname,
-				id: Date.now() + '_' + sb.randomString(),
-			},
-			form_submission: {id: formid, values: values},
-			message_sent: {
-				data: {
-					message: {format: 'plaintext', text: text},
-				},
-			},
-		})
+		const payload = formRequest(formid, values, options)
+		return this.store.submitWebsiteForm(formid, payload)
+	}
+
+	async getFormStatus(formid) {
+		validateWebsiteFormId(formid)
+		await this.store.readyGate.entry()
+		return this.store.getFormStatus(formid)
 	}
 
 	// req.bot_id != "" -> start conversation with bot id
@@ -404,3 +391,30 @@ window.__sbz_WIDGET = Widget
 export default Widget
 
 // lib.submitForm('cprkztryyobndhbvwzjab', [{key: 'fullname', value: 'Pham Kieu Thanh 2' }, {key: 'phones', value: "0366621895"}]
+
+
+function validateWebsiteFormId(formid) {
+	if (typeof formid !== 'string' || !/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/.test(formid)) {
+		throw new TypeError('Form ID must contain 1-64 letters, digits, underscores or hyphens')
+	}
+	if (formid.startsWith('cp')) throw new TypeError('Form IDs starting with cp are reserved for Subiz campaigns')
+}
+
+function formRequest(formid, fields, options = {}) {
+	validateWebsiteFormId(formid)
+	if (!Array.isArray(fields) || !fields.length) throw new TypeError('Form fields must be a nonempty array')
+	if (!options || typeof options !== 'object' || Array.isArray(options)) throw new TypeError('Form options must be an object')
+	return {
+		form_name: options.name === undefined ? formid : options.name,
+		page_url: options.page_url === undefined ? window.location.href : options.page_url,
+		submission_id: options.submission_id === undefined ? sb.randomString(36) : options.submission_id,
+		values: fields.map((field) => {
+			if (!field || typeof field.key !== 'string') throw new TypeError('Each field requires a key')
+			const value = field.value
+			if (value != null && !['string', 'number', 'boolean'].includes(typeof value)) {
+				throw new TypeError('Form field values must be strings, numbers or booleans')
+			}
+			return {key: field.key, label: field.label === undefined ? field.key : field.label, value: value == null ? '' : String(value)}
+		}),
+	}
+}

package/src/store/api.js

@@ -271,6 +271,12 @@ export default class {
 			.addQuery('x-referer', sb.get(location, 'origin', ''))
 			.post(`/accounts/${this.accid}/users/${this.uid}/events`, data)
 
+	// Keep the configured API host and all widget authentication hooks.
+	websiteFormRequest = () => this.apireq.setBaseUrl(this.ApiURL.replace(/\/4\.[01]\/?$/, '/4.1'))
+
+	submitWebsiteForm = (formid, payload) => this.websiteFormRequest()
+		.post(`/accounts/${this.accid}/external-forms/${encodeURIComponent(formid)}/submissions`, payload)
+
 	submitForm = (form_id, page_url, device, data, user) =>
 		this.apireq
 			.addQuery('x-referer', sb.get(location, 'origin', ''))

package/src/store/store.js

@@ -955,6 +955,36 @@ export default class Store {
 		}
 	}
 
+	async submitWebsiteForm(formid, payload) {
+		await this.readyGate.entry()
+		const key = websiteFormStorageKey(this.api, formid)
+		const kv = this.kv
+		const result = formResult(await this.api.submitWebsiteForm(formid, payload))
+		try {
+			kv.put(key, {conversation_id: result.conversation_id, expires_at: sb.Date.now() + 7 * 24 * 60 * 60 * 1000})
+		} catch (_) { /* Storage failure must not make callers retry a successful submission. */ }
+		return result
+	}
+
+	getFormStatus(formid) {
+		const key = websiteFormStorageKey(this.api, formid)
+		try {
+			const receipt = this.kv.match(key)
+			if (!receipt) return {submitted: false, status: 'not_found'}
+			if (!Number.isFinite(receipt.expires_at) || typeof receipt.conversation_id !== 'string' || !receipt.conversation_id) {
+				this.kv.del(key)
+				return {submitted: false, status: 'not_found'}
+			}
+			if (receipt.expires_at <= sb.Date.now()) {
+				this.kv.del(key)
+				return {submitted: false, status: 'expired'}
+			}
+			return {submitted: true, status: 'found', conversation_id: receipt.conversation_id}
+		} catch (_) {
+			return {submitted: false, status: 'storage_unavailable'}
+		}
+	}
+
 	async submitForm(formid, data, user) {
 		await this.readyGate.entry()
 		if (user) await this.setUser(user)
@@ -1117,6 +1147,9 @@ export default class Store {
 	async _onWs(ev) {
 		if (this._die) return
 		if (!ev || !ev.type) return
+		// Website form conversations are handled in the agent inbox, not the chat widget.
+		// Ignore their realtime events before an unknown conversation triggers a GET.
+		if (sb.get(ev, 'touchpoint.channel') === 'form' || sb.get(ev, 'data.conversation.touchpoint.channel') === 'form') return
 		ev.created = sb.getMs(ev.created)
 		if (ev.type === 'user_info_updated') {
 			return
@@ -1916,3 +1949,21 @@ var xhrsend = function (method, url, body, cb) {
 }
 
 const dieErr = new Error('sdk unloaded')
+
+function websiteFormStorageKey(api, formid) {
+	return 'sbz_form_submitted:' + sb.stringify([api.accid, api.uid, formid])
+}
+
+function formResult(response) {
+	const body = response && response.body
+	const detail = (response && response.error) || (body && body.error)
+	const status = response && response.code
+	const valid = body && typeof body.conversation_id === 'string' && body.conversation_id && typeof body.submission_id === 'string' && body.submission_id
+	if (detail || !(status >= 200 && status < 300) || !valid) {
+		const error = new Error('Subiz form request failed')
+		error.code = (detail && detail.code) || 'form_request_failed'
+		error.status = status
+		throw error
+	}
+	return body
+}