@subiz/widget-v4 4.1.213 → 4.1.214

package/api.md

@@ -1222,3 +1222,60 @@ 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)` trả `{submitted, status, conversation_id?}`, chỉ hỗ trợ ID
+website không bắt đầu bằng `cp`. Cả hội thoại đã kết thúc cũng được tính.
+`status: 'found'` nghĩa là tìm thấy lần gửi; `'not_found_in_available_history'`
+không khẳng định khách chưa từng gửi. Service hiện chỉ đọc tối đa 200 dòng lịch sử
+khách trước khi lọc theo form, sau đó trả tối đa 6 hội thoại; cache và việc xóa dữ
+liệu cũng ảnh hưởng kết quả. Lần gửi theo luồng cũ dùng hostname làm nguồn hoặc
+CF7 ticket chưa được tra cứu bằng API này. Khách cần được nhận diện lại bằng cùng
+phiên widget; không đảm bảo khi xóa dữ liệu trình duyệt hoặc đổi thiết bị.

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 formResult(await this.store.api.submitWebsiteForm(formid, payload), 'submit');
+  }
+  async getFormStatus(formid) {
+    validateWebsiteFormId(formid);
+    await this.store.readyGate.entry();
+    return formResult(await this.store.api.getWebsiteFormStatus(formid), 'status');
   }
   startConvo(req) {
     req = _index.default.cloneDeep(req) || {};
@@ -369,4 +350,45 @@ 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)
+      };
+    })
+  };
+}
+function formResult(response, operation) {
+  const body = response && response.body;
+  const detail = response && response.error || body && body.error;
+  const status = response && response.code;
+  const valid = operation === 'submit' ? body && typeof body.conversation_id === 'string' && body.conversation_id && typeof body.submission_id === 'string' && body.submission_id : body && typeof body.submitted === 'boolean' && typeof body.status === 'string';
+  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/compiled_src/store/api.js

@@ -63,6 +63,9 @@ 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, "getWebsiteFormStatus", formid => this.websiteFormRequest().get(`/accounts/${this.accid}/external-forms/${encodeURIComponent(formid)}/status`));
     _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/dist/.HASH

@@ -0,0 +1 @@
+1a12a372880