@subiz/widget-v4 4.1.213 → 4.1.215

package/api.md

@@ -1222,3 +1222,72 @@ subiz('event', 'product_viewed', {
 	name: 'Bàn phím cơ không dây',
 })
 ```
+
+## Form website: tạo hội thoại và kiểm tra lần gửi trước
+
+```js
+subiz('waitReady', async function () {
+  const result = await subiz('submitForm', 'website_contact', [
+    {key: 'fullname', label: 'Họ tên', value: 'Nguyễn Văn An'},
+    {key: 'phones', value: '0901234567'},
+  ], {
+    name: 'Đăng ký tư vấn',
+    // page_url: 'https://example.com/contact',
+    // submission_id: 'registration-123',
+  })
+  // result: {conversation_id, submission_id}
+})
+```
+
+Chữ ký: `submitForm(formId, fields, options?)`. Tham số thứ hai luôn là mảng.
+`label` mặc định bằng `key`. Giá trị string, number, boolean được gửi dưới dạng
+chuỗi; null/undefined thành chuỗi rỗng. `options.name` mặc định bằng formId,
+`page_url` bằng URL hiện tại, `submission_id` được SDK tự sinh.
+
+SDK chờ phiên khách sẵn sàng và dùng xác thực hiện có. API lỗi hoặc phản hồi sai
+định dạng sẽ reject Promise, lỗi có `code` và `status`. Không tự retry submit:
+`submission_id` chưa chống tạo trùng. Website nên khóa nút trong khi gửi.
+Khi SDK chưa tải, loader chỉ xếp hàng lệnh và chưa trả Promise; dùng `waitReady`
+như ví dụ để gọi `await` an toàn.
+
+ID bắt đầu bằng `cp` vẫn dùng luồng popup/campaign cũ, giữ nguyên kiểu kết quả cũ;
+options mới không áp dụng cho nhánh này. ID website khác `cp` chuyển sang API form
+mới: tạo hội thoại kênh form, không tự cập nhật thuộc tính hồ sơ khách. Backend mới
+phải được deploy trước khi phát hành SDK.
+
+Giới hạn: ID form và key dài 1–64 ký tự ASCII chữ/số/`_`/`-`, bắt đầu bằng chữ/số;
+1–50 trường; label/tên form tối đa 200 byte, giá trị 4096 byte, URL HTTP(S) 500 byte,
+toàn bộ JSON 32 KiB. Ít nhất một giá trị không rỗng. Kiểm tra bắt buộc/email theo
+nghiệp vụ của form do website thực hiện.
+
+```js
+subiz('waitReady', async function () {
+  try {
+    const result = await subiz('getFormStatus', 'website_contact')
+    if (result.submitted) document.getElementById('contact-form').hidden = true
+  } catch (error) {
+    // Không ẩn form khi kiểm tra thất bại.
+  }
+})
+```
+
+`getFormStatus(formId)` đọc qua store KV/LSDB của widget, không gọi API trạng thái
+hay lấy hội thoại. Sau khi submit thành công, SDK lưu dấu đã gửi trong 7 ngày,
+tách theo account, ID khách và ID form. Chỉ lưu mã hội thoại và thời điểm hết hạn,
+không lưu các giá trị khách nhập. Đọc trạng thái không gia hạn thời gian lưu.
+
+Kết quả: `{submitted: true, status: 'found', conversation_id}` nếu còn hạn;
+`{submitted: false, status: 'not_found'}` nếu chưa lưu; `status: 'expired'` khi
+hết hạn (đồng thời xóa bản ghi); `status: 'storage_unavailable'` khi trình duyệt
+không cho truy cập localStorage. Lỗi lưu localStorage không biến một submit đã
+thành công thành thất bại. Website nên ẩn form ngay sau khi submit thành công.
+
+SDK bỏ qua sự kiện realtime của hội thoại kênh form trước khi lấy chi tiết hội
+thoại; không mở hội thoại form trong chat widget. Luồng chat thông thường giữ
+nguyên. Trạng thái chỉ có trên cùng website/trình duyệt và cùng ID khách, không
+đồng bộ thiết bị khác, mất khi xóa localStorage. Các lần gửi trước khi bổ sung
+cơ chế lưu này không được tự khôi phục từ server.
+
+SDK không truy cập localStorage trực tiếp: store dùng `kv.put/match/del` và
+LSDB hiện có. Khi widget dùng chế độ in-memory hoặc trình duyệt chặn lưu trữ,
+trạng thái có thể chỉ giữ trong bộ nhớ của trang và mất khi tải lại.

package/compiled_src/lib.js

@@ -199,8 +199,9 @@ class 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 (_index.default.startsWith(formid, 'cp')) {
       let storeuser = _index.default.cloneDeep(this.store.matchUser());
       let user = {
@@ -231,33 +232,13 @@ class Widget {
       this.store.setUserDiff(user);
       return this.store.sendConversion(formid, values, impressiontoken);
     }
-    values = _index.default.filter(values, field => {
-      return field.key && field.value;
-    });
-    let text = 'Khách điền form\n';
-    _index.default.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() + '_' + _index.default.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 = _index.default.cloneDeep(req) || {};
@@ -369,4 +350,32 @@ class Widget {
   }
 }
 window.__sbz_WIDGET = Widget;
-var _default = exports.default = Widget;
+var _default = exports.default = 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 ? _index.default.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/compiled_src/store/api.js

@@ -63,6 +63,8 @@ class _default {
     _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', _index.default.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', _index.default.get(location, 'origin', '')).post(`/accounts/${this.accid}/users/${this.uid}/events`, {
       by: {
         id: this.uid,

package/compiled_src/store/store.js

@@ -881,6 +881,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: _index.default.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 <= _index.default.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);
@@ -1008,6 +1055,7 @@ class Store {
   async _onWs(ev) {
     if (this._die) return;
     if (!ev || !ev.type) return;
+    if (_index.default.get(ev, 'touchpoint.channel') === 'form' || _index.default.get(ev, 'data.conversation.touchpoint.channel') === 'form') return;
     ev.created = _index.default.getMs(ev.created);
     if (ev.type === 'user_info_updated') {
       return;
@@ -1757,4 +1805,20 @@ var xhrsend = function (method, url, body, cb) {
   if (body) request.setRequestHeader('content-type', 'text/plain');
   request.send(body);
 };
-const dieErr = new Error('sdk unloaded');
+const dieErr = new Error('sdk unloaded');
+function websiteFormStorageKey(api, formid) {
+  return 'sbz_form_submitted:' + _index.default.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;
+}

package/dist/.HASH

@@ -0,0 +1 @@
+1a12a5ed6a9