@talqui-oss/template-builder 0.0.0-stage → 0.1.0-alpha.0

package/dist/adapters/talqui.cjs

@@ -0,0 +1,263 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/adapters/talqui.ts
+var talqui_exports = {};
+__export(talqui_exports, {
+  talqui: () => talqui
+});
+module.exports = __toCommonJS(talqui_exports);
+
+// src/validate/text.ts
+var PLACEHOLDER = /\{\{(.*?)\}\}/g;
+var VARIABLE_NAME = /^[a-z][a-z0-9_]*$/;
+function placeholders(text) {
+  return [...text.matchAll(PLACEHOLDER)].map((match) => {
+    const name = match[1] ?? "";
+    return { raw: match[0], name, valid: VARIABLE_NAME.test(name) };
+  });
+}
+
+// src/variables.ts
+var replacePlaceholders = (text, replace) => text.replace(/\{\{(.*?)\}\}/g, (_, name) => replace(name));
+
+// src/adapters/types.ts
+function defineAdapter(definition) {
+  return (...[options]) => ({
+    name: definition.name,
+    toRequests: (template) => definition.toRequests(template, options ?? {})
+  });
+}
+var UnsupportedByProviderError = class extends Error {
+  constructor(provider, path, message) {
+    super(`${provider}: ${message} (${path})`);
+    this.provider = provider;
+    this.path = path;
+    this.name = "UnsupportedByProviderError";
+  }
+  provider;
+  path;
+  code = "UNSUPPORTED_BY_PROVIDER";
+};
+function unsupported(provider, path, what) {
+  throw new UnsupportedByProviderError(
+    provider,
+    path,
+    `${what} is not supported by this provider.`
+  );
+}
+
+// src/adapters/talqui.ts
+var NAME = "talqui";
+var AUTHENTICATION_PREVIEW = "*123456* \xE9 o seu c\xF3digo de verifica\xE7\xE3o.";
+var EMPTY_HEADER = {
+  type: null,
+  content: {},
+  preview: "",
+  text: "",
+  variables: []
+};
+var CHANNELS = {
+  "whatsapp-cloud": "urn:talqui:whatsapp-cloud:0",
+  "whatsapp-gup": "urn:talqui:whatsapp-gup:0"
+};
+var talqui = defineAdapter({
+  name: NAME,
+  toRequests(template, {
+    tenantId = "$TALQUI_TENANT_ID",
+    channel = "whatsapp-cloud",
+    channelId = "$TALQUI_CHANNEL_ID",
+    auth = "operator",
+    token = "$TALQUI_TOKEN"
+  }) {
+    if (template.language !== "pt_BR")
+      unsupported(NAME, "language", `The ${template.language} language`);
+    if (template.messageSendTtlSeconds !== void 0)
+      unsupported(NAME, "messageSendTtlSeconds", "A message TTL");
+    if (template.category === "AUTHENTICATION" && channel === "whatsapp-cloud")
+      unsupported(
+        NAME,
+        "category",
+        "Authentication on the whatsapp-cloud channel"
+      );
+    return [
+      {
+        method: "POST",
+        url: `https://services-api.talqui.chat/v1/tenants/${tenantId}/campaigns-models`,
+        headers: {
+          Authorization: `${auth === "operator" ? "Bearer" : "PluginConnection"} ${token}`,
+          "Content-Type": "application/json"
+        },
+        body: {
+          // Talqui slugifies the name (dropping `_`) and turns `-` back into `_` for Meta.
+          campaignModelName: template.name.replaceAll("_", "-"),
+          campaignModelType: template.category,
+          campaignModelChannel: CHANNELS[channel],
+          campaignModelChannelID: channelId,
+          campaignModelMeta: { allowedToStartSession: "denied" },
+          campaignModelGatewayMeta: template.category !== "AUTHENTICATION" && template.displayFormat ? { displayFormat: template.displayFormat } : {},
+          campaignModelSlots: template.category === "AUTHENTICATION" ? authentication(template) : standard(template)
+        }
+      }
+    ];
+  }
+});
+var spaced = (text) => replacePlaceholders(text, (name) => `{{ ${name} }}`);
+var escapeHtml = (text) => text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+var CHIP_COLORS = [
+  "ab7df6",
+  "7f8fa4",
+  "26c1c9",
+  "fd7b1f",
+  "e0102b",
+  "40b630",
+  "0079c4"
+];
+var chipColor = (name) => CHIP_COLORS[[...name].reduce((sum, char) => sum + char.charCodeAt(0), 0) % CHIP_COLORS.length];
+var MARKS = [
+  [/\*([^*\n]+)\*/g, "strong", "t-attribute-bold"],
+  [/_([^_\n]+)_/g, "em", "t-attribute-italic"],
+  [/~([^~\n]+)~/g, "s", "t-attribute-strike"]
+];
+var editorHtml = (text, variables = {}) => {
+  const names = [];
+  let html = replacePlaceholders(
+    escapeHtml(text),
+    (name) => `\uE000${names.push(name) - 1}\uE000`
+  );
+  for (const [pattern, tag, className] of MARKS)
+    html = html.replace(pattern, `<${tag} class="${className}">$1</${tag}>`);
+  html = html.replace(/\uE000(\d+)\uE000/g, (_, index) => {
+    const name = names[Number(index)] ?? "";
+    return `<span class="variable" data-type="variable" data-id="${name}" data-key="${name}" data-label="${name}" data-default-value="${escapeHtml(variables[name]?.example ?? "")}" style="background-color: #${chipColor(name)};">${name}</span>`;
+  });
+  return `<p>${html.replace(/\n/g, "<br>")}</p>`;
+};
+var editorDoc = (text, variables = {}) => ({
+  type: "doc",
+  content: [
+    {
+      type: "paragraph",
+      content: text.split(/(\{\{.*?\}\})/).filter(Boolean).map((part) => {
+        const name = /^\{\{(.*?)\}\}$/.exec(part)?.[1];
+        return name ? {
+          type: "variable",
+          attrs: {
+            id: name,
+            key: name,
+            label: name,
+            defaultValue: variables[name]?.example ?? ""
+          }
+        } : { type: "text", text: part };
+      })
+    }
+  ]
+});
+var slotVariables = (text, variables = {}) => [...new Set(placeholders(text).map((p) => p.name))].map((name) => ({
+  id: name,
+  key: name,
+  type: "text",
+  fallback: variables[name]?.example
+}));
+function standard(t) {
+  if (t.limitedTimeOffer)
+    unsupported(NAME, "limitedTimeOffer", "A limited-time offer");
+  if (t.carousel) unsupported(NAME, "carousel", "A carousel");
+  if (t.callPermissionRequest)
+    unsupported(NAME, "callPermissionRequest", "A call permission request");
+  return {
+    header: header(t),
+    body: {
+      content: editorHtml(t.body.text, t.variables),
+      text: spaced(t.body.text),
+      variables: slotVariables(t.body.text, t.variables)
+    },
+    buttons: (t.buttons ?? []).map(
+      (b, index) => button(b, t.variables, `buttons.${index}`)
+    ),
+    footer: t.footer ? { text: t.footer.text } : {}
+  };
+}
+function header({ header: h, variables }) {
+  if (!h) return EMPTY_HEADER;
+  if (h.type === "TEXT")
+    return {
+      type: "text",
+      content: editorDoc(h.text, variables),
+      preview: editorHtml(h.text, variables),
+      text: spaced(h.text),
+      variables: slotVariables(h.text, variables)
+    };
+  if (h.type === "IMAGE" || h.type === "VIDEO" || h.type === "DOCUMENT") {
+    const type = h.type.toLowerCase();
+    return {
+      ...EMPTY_HEADER,
+      type,
+      variables: [{ id: "header", key: "header", type, fallback: h.url }]
+    };
+  }
+  return unsupported(NAME, "header", `A ${h.type} header`);
+}
+function button(b, variables = {}, path) {
+  switch (b.type) {
+    case "QUICK_REPLY":
+    case "ORDER_DETAILS":
+      return { type: b.type, text: b.text };
+    case "URL": {
+      const [param] = placeholders(b.url);
+      return {
+        type: b.type,
+        text: b.text,
+        url: param ? b.url.replace(param.raw, "{{1}}") : b.url,
+        example: param ? [variables[param.name]?.example ?? ""] : void 0
+      };
+    }
+    case "PHONE_NUMBER":
+      return { type: b.type, text: b.text, phone_number: b.phoneNumber };
+    case "VOICE_CALL":
+      return { type: b.type, text: b.text, ttl_minutes: b.ttlMinutes };
+    case "COPY_CODE":
+      return { type: b.type, example: [b.example] };
+    default:
+      return unsupported(NAME, path, `The ${b.type} button`);
+  }
+}
+function authentication(t) {
+  if (t.body?.addSecurityRecommendation !== void 0)
+    unsupported(NAME, "body.addSecurityRecommendation", "The security line");
+  if (t.footer?.codeExpirationMinutes !== void 0)
+    unsupported(NAME, "footer.codeExpirationMinutes", "The code expiration");
+  if (t.button.otpType !== "COPY_CODE")
+    unsupported(NAME, "button.otpType", `The ${t.button.otpType} OTP button`);
+  return {
+    header: EMPTY_HEADER,
+    // Meta writes the authentication body; Talqui only requires a non-empty text, shown in its preview.
+    body: {
+      content: editorHtml(AUTHENTICATION_PREVIEW),
+      text: AUTHENTICATION_PREVIEW,
+      variables: []
+    },
+    buttons: [{ type: "OTP", otp_type: "COPY_CODE" }],
+    footer: {}
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  talqui
+});

package/dist/adapters/talqui.d.cts

@@ -0,0 +1,19 @@
+import { Adapter } from '../index.cjs';
+
+type TalquiOptions = {
+    /** Default: `$TALQUI_TENANT_ID`. */
+    tenantId?: string;
+    /** WhatsApp channel the template belongs to. Default: `whatsapp-cloud`. */
+    channel?: "whatsapp-cloud" | "whatsapp-gup";
+    /** Channel connection ID. Default: `$TALQUI_CHANNEL_ID`. */
+    channelId?: string;
+    /** `operator` sends `Bearer <token>`, `pluginConnection` sends `PluginConnection <token>`. Default: `operator`. */
+    auth?: "operator" | "pluginConnection";
+    /** Default: `$TALQUI_TOKEN`. */
+    token?: string;
+};
+/** Talqui: `POST /v1/tenants/{tenantID}/campaigns-models`. */
+declare const talqui: (options?: TalquiOptions | undefined) => Adapter;
+
+export { talqui };
+export type { TalquiOptions };

package/dist/adapters/talqui.d.ts

@@ -0,0 +1,19 @@
+import { Adapter } from '../index.js';
+
+type TalquiOptions = {
+    /** Default: `$TALQUI_TENANT_ID`. */
+    tenantId?: string;
+    /** WhatsApp channel the template belongs to. Default: `whatsapp-cloud`. */
+    channel?: "whatsapp-cloud" | "whatsapp-gup";
+    /** Channel connection ID. Default: `$TALQUI_CHANNEL_ID`. */
+    channelId?: string;
+    /** `operator` sends `Bearer <token>`, `pluginConnection` sends `PluginConnection <token>`. Default: `operator`. */
+    auth?: "operator" | "pluginConnection";
+    /** Default: `$TALQUI_TOKEN`. */
+    token?: string;
+};
+/** Talqui: `POST /v1/tenants/{tenantID}/campaigns-models`. */
+declare const talqui: (options?: TalquiOptions | undefined) => Adapter;
+
+export { talqui };
+export type { TalquiOptions };

package/dist/adapters/talqui.js

@@ -0,0 +1,206 @@
+import {
+  replacePlaceholders
+} from "../chunk-SMN4WTO3.js";
+import {
+  defineAdapter,
+  placeholders,
+  unsupported
+} from "../chunk-ULTGMISN.js";
+
+// src/adapters/talqui.ts
+var NAME = "talqui";
+var AUTHENTICATION_PREVIEW = "*123456* \xE9 o seu c\xF3digo de verifica\xE7\xE3o.";
+var EMPTY_HEADER = {
+  type: null,
+  content: {},
+  preview: "",
+  text: "",
+  variables: []
+};
+var CHANNELS = {
+  "whatsapp-cloud": "urn:talqui:whatsapp-cloud:0",
+  "whatsapp-gup": "urn:talqui:whatsapp-gup:0"
+};
+var talqui = defineAdapter({
+  name: NAME,
+  toRequests(template, {
+    tenantId = "$TALQUI_TENANT_ID",
+    channel = "whatsapp-cloud",
+    channelId = "$TALQUI_CHANNEL_ID",
+    auth = "operator",
+    token = "$TALQUI_TOKEN"
+  }) {
+    if (template.language !== "pt_BR")
+      unsupported(NAME, "language", `The ${template.language} language`);
+    if (template.messageSendTtlSeconds !== void 0)
+      unsupported(NAME, "messageSendTtlSeconds", "A message TTL");
+    if (template.category === "AUTHENTICATION" && channel === "whatsapp-cloud")
+      unsupported(
+        NAME,
+        "category",
+        "Authentication on the whatsapp-cloud channel"
+      );
+    return [
+      {
+        method: "POST",
+        url: `https://services-api.talqui.chat/v1/tenants/${tenantId}/campaigns-models`,
+        headers: {
+          Authorization: `${auth === "operator" ? "Bearer" : "PluginConnection"} ${token}`,
+          "Content-Type": "application/json"
+        },
+        body: {
+          // Talqui slugifies the name (dropping `_`) and turns `-` back into `_` for Meta.
+          campaignModelName: template.name.replaceAll("_", "-"),
+          campaignModelType: template.category,
+          campaignModelChannel: CHANNELS[channel],
+          campaignModelChannelID: channelId,
+          campaignModelMeta: { allowedToStartSession: "denied" },
+          campaignModelGatewayMeta: template.category !== "AUTHENTICATION" && template.displayFormat ? { displayFormat: template.displayFormat } : {},
+          campaignModelSlots: template.category === "AUTHENTICATION" ? authentication(template) : standard(template)
+        }
+      }
+    ];
+  }
+});
+var spaced = (text) => replacePlaceholders(text, (name) => `{{ ${name} }}`);
+var escapeHtml = (text) => text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+var CHIP_COLORS = [
+  "ab7df6",
+  "7f8fa4",
+  "26c1c9",
+  "fd7b1f",
+  "e0102b",
+  "40b630",
+  "0079c4"
+];
+var chipColor = (name) => CHIP_COLORS[[...name].reduce((sum, char) => sum + char.charCodeAt(0), 0) % CHIP_COLORS.length];
+var MARKS = [
+  [/\*([^*\n]+)\*/g, "strong", "t-attribute-bold"],
+  [/_([^_\n]+)_/g, "em", "t-attribute-italic"],
+  [/~([^~\n]+)~/g, "s", "t-attribute-strike"]
+];
+var editorHtml = (text, variables = {}) => {
+  const names = [];
+  let html = replacePlaceholders(
+    escapeHtml(text),
+    (name) => `\uE000${names.push(name) - 1}\uE000`
+  );
+  for (const [pattern, tag, className] of MARKS)
+    html = html.replace(pattern, `<${tag} class="${className}">$1</${tag}>`);
+  html = html.replace(/\uE000(\d+)\uE000/g, (_, index) => {
+    const name = names[Number(index)] ?? "";
+    return `<span class="variable" data-type="variable" data-id="${name}" data-key="${name}" data-label="${name}" data-default-value="${escapeHtml(variables[name]?.example ?? "")}" style="background-color: #${chipColor(name)};">${name}</span>`;
+  });
+  return `<p>${html.replace(/\n/g, "<br>")}</p>`;
+};
+var editorDoc = (text, variables = {}) => ({
+  type: "doc",
+  content: [
+    {
+      type: "paragraph",
+      content: text.split(/(\{\{.*?\}\})/).filter(Boolean).map((part) => {
+        const name = /^\{\{(.*?)\}\}$/.exec(part)?.[1];
+        return name ? {
+          type: "variable",
+          attrs: {
+            id: name,
+            key: name,
+            label: name,
+            defaultValue: variables[name]?.example ?? ""
+          }
+        } : { type: "text", text: part };
+      })
+    }
+  ]
+});
+var slotVariables = (text, variables = {}) => [...new Set(placeholders(text).map((p) => p.name))].map((name) => ({
+  id: name,
+  key: name,
+  type: "text",
+  fallback: variables[name]?.example
+}));
+function standard(t) {
+  if (t.limitedTimeOffer)
+    unsupported(NAME, "limitedTimeOffer", "A limited-time offer");
+  if (t.carousel) unsupported(NAME, "carousel", "A carousel");
+  if (t.callPermissionRequest)
+    unsupported(NAME, "callPermissionRequest", "A call permission request");
+  return {
+    header: header(t),
+    body: {
+      content: editorHtml(t.body.text, t.variables),
+      text: spaced(t.body.text),
+      variables: slotVariables(t.body.text, t.variables)
+    },
+    buttons: (t.buttons ?? []).map(
+      (b, index) => button(b, t.variables, `buttons.${index}`)
+    ),
+    footer: t.footer ? { text: t.footer.text } : {}
+  };
+}
+function header({ header: h, variables }) {
+  if (!h) return EMPTY_HEADER;
+  if (h.type === "TEXT")
+    return {
+      type: "text",
+      content: editorDoc(h.text, variables),
+      preview: editorHtml(h.text, variables),
+      text: spaced(h.text),
+      variables: slotVariables(h.text, variables)
+    };
+  if (h.type === "IMAGE" || h.type === "VIDEO" || h.type === "DOCUMENT") {
+    const type = h.type.toLowerCase();
+    return {
+      ...EMPTY_HEADER,
+      type,
+      variables: [{ id: "header", key: "header", type, fallback: h.url }]
+    };
+  }
+  return unsupported(NAME, "header", `A ${h.type} header`);
+}
+function button(b, variables = {}, path) {
+  switch (b.type) {
+    case "QUICK_REPLY":
+    case "ORDER_DETAILS":
+      return { type: b.type, text: b.text };
+    case "URL": {
+      const [param] = placeholders(b.url);
+      return {
+        type: b.type,
+        text: b.text,
+        url: param ? b.url.replace(param.raw, "{{1}}") : b.url,
+        example: param ? [variables[param.name]?.example ?? ""] : void 0
+      };
+    }
+    case "PHONE_NUMBER":
+      return { type: b.type, text: b.text, phone_number: b.phoneNumber };
+    case "VOICE_CALL":
+      return { type: b.type, text: b.text, ttl_minutes: b.ttlMinutes };
+    case "COPY_CODE":
+      return { type: b.type, example: [b.example] };
+    default:
+      return unsupported(NAME, path, `The ${b.type} button`);
+  }
+}
+function authentication(t) {
+  if (t.body?.addSecurityRecommendation !== void 0)
+    unsupported(NAME, "body.addSecurityRecommendation", "The security line");
+  if (t.footer?.codeExpirationMinutes !== void 0)
+    unsupported(NAME, "footer.codeExpirationMinutes", "The code expiration");
+  if (t.button.otpType !== "COPY_CODE")
+    unsupported(NAME, "button.otpType", `The ${t.button.otpType} OTP button`);
+  return {
+    header: EMPTY_HEADER,
+    // Meta writes the authentication body; Talqui only requires a non-empty text, shown in its preview.
+    body: {
+      content: editorHtml(AUTHENTICATION_PREVIEW),
+      text: AUTHENTICATION_PREVIEW,
+      variables: []
+    },
+    buttons: [{ type: "OTP", otp_type: "COPY_CODE" }],
+    footer: {}
+  };
+}
+export {
+  talqui
+};