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

package/dist/adapters/twilio.cjs

@@ -0,0 +1,215 @@
+"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/twilio.ts
+var twilio_exports = {};
+__export(twilio_exports, {
+  twilio: () => twilio
+});
+module.exports = __toCommonJS(twilio_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
+function textFields(template) {
+  if (template.category === "AUTHENTICATION") return [];
+  const fields = [];
+  if (template.header?.type === "TEXT")
+    fields.push({ path: "header.text", text: template.header.text });
+  fields.push({ path: "body.text", text: template.body.text });
+  template.carousel?.cards.forEach((card, index) => {
+    if (card.body)
+      fields.push({
+        path: `carousel.cards.${index}.body.text`,
+        text: card.body.text
+      });
+  });
+  template.buttons?.forEach((button, index) => {
+    if (button.type === "URL")
+      fields.push({ path: `buttons.${index}.url`, text: button.url });
+  });
+  template.carousel?.cards.forEach((card, cardIndex) => {
+    card.buttons?.forEach((button, index) => {
+      if (button.type === "URL")
+        fields.push({
+          path: `carousel.cards.${cardIndex}.buttons.${index}.url`,
+          text: button.url
+        });
+    });
+  });
+  return fields;
+}
+var replacePlaceholders = (text, replace) => text.replace(/\{\{(.*?)\}\}/g, (_, name) => replace(name));
+function extractVariables(template) {
+  const names = textFields(template).flatMap(
+    (field) => placeholders(field.text).map((p) => p.name)
+  );
+  return [...new Set(names)];
+}
+
+// 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/twilio.ts
+var NAME = "twilio";
+var CONTENT_SID = "$CONTENT_SID";
+var twilio = defineAdapter({
+  name: NAME,
+  toRequests(template, { accountSid = "$TWILIO_ACCOUNT_SID", authToken = "$TWILIO_AUTH_TOKEN" }) {
+    if (template.messageSendTtlSeconds !== void 0)
+      unsupported(NAME, "messageSendTtlSeconds", "A message TTL");
+    const credentials = accountSid.startsWith("$") || authToken.startsWith("$") ? `$(printf %s ${accountSid}:${authToken} | base64)` : btoa(`${accountSid}:${authToken}`);
+    const headers = {
+      Authorization: `Basic ${credentials}`,
+      "Content-Type": "application/json"
+    };
+    const order = extractVariables(template);
+    return [
+      {
+        method: "POST",
+        url: "https://content.twilio.com/v1/Content",
+        headers,
+        body: {
+          friendly_name: template.name,
+          language: template.language,
+          variables: order.length ? Object.fromEntries(
+            order.map((name, index) => [
+              String(index + 1),
+              template.category === "AUTHENTICATION" ? void 0 : template.variables?.[name]?.example
+            ])
+          ) : void 0,
+          types: template.category === "AUTHENTICATION" ? authentication(template) : standard(template, positional(order))
+        }
+      },
+      {
+        method: "POST",
+        url: `https://content.twilio.com/v1/Content/${CONTENT_SID}/ApprovalRequests/whatsapp`,
+        headers,
+        body: { name: template.name, category: template.category },
+        comments: [
+          `Replace ${CONTENT_SID} with the "sid" returned by the request above.`
+        ]
+      }
+    ];
+  }
+});
+var positional = (order) => (text) => replacePlaceholders(text, (name) => `{{${order.indexOf(name) + 1}}}`);
+function standard(t, pos) {
+  if (t.limitedTimeOffer)
+    unsupported(NAME, "limitedTimeOffer", "A limited-time offer");
+  if (t.callPermissionRequest)
+    unsupported(NAME, "callPermissionRequest", "A call permission request");
+  if (t.displayFormat)
+    unsupported(NAME, "displayFormat", "The ORDER_DETAILS display format");
+  const body = pos(t.body.text);
+  if (t.carousel)
+    return {
+      "twilio/carousel": {
+        body,
+        cards: t.carousel.cards.map((card, index) => {
+          const path = `carousel.cards.${index}`;
+          if (card.header.type === "PRODUCT")
+            unsupported(NAME, `${path}.header`, "A PRODUCT card header");
+          return {
+            body: card.body && pos(card.body.text),
+            media: "url" in card.header ? card.header.url : void 0,
+            actions: actions(card.buttons ?? [], pos, `${path}.buttons`)
+          };
+        })
+      }
+    };
+  const header = t.header;
+  if (header && !["TEXT", "IMAGE", "VIDEO", "DOCUMENT"].includes(header.type))
+    unsupported(NAME, "header", `A ${header.type} header`);
+  if (!header && !t.footer && !t.buttons?.length)
+    return { "twilio/text": { body } };
+  return {
+    "whatsapp/card": {
+      body,
+      header_text: header?.type === "TEXT" ? pos(header.text) : void 0,
+      media: header && "url" in header ? [header.url] : void 0,
+      footer: t.footer?.text,
+      actions: t.buttons?.length ? actions(t.buttons, pos, "buttons") : void 0
+    }
+  };
+}
+function actions(buttons, pos, path) {
+  return buttons.map((b, index) => {
+    switch (b.type) {
+      case "QUICK_REPLY":
+        return { type: b.type, title: b.text, id: b.text };
+      case "URL":
+        return { type: b.type, title: b.text, url: pos(b.url) };
+      case "PHONE_NUMBER":
+        return { type: b.type, title: b.text, phone: b.phoneNumber };
+      case "COPY_CODE":
+        return { type: b.type, code: b.example };
+      default:
+        return unsupported(NAME, `${path}.${index}`, `The ${b.type} button`);
+    }
+  });
+}
+function authentication(t) {
+  if (t.button.otpType !== "COPY_CODE")
+    unsupported(NAME, "button.otpType", `The ${t.button.otpType} OTP button`);
+  return {
+    "whatsapp/authentication": {
+      add_security_recommendation: t.body?.addSecurityRecommendation,
+      code_expiration_minutes: t.footer?.codeExpirationMinutes,
+      actions: [
+        { type: "COPY_CODE", copy_code_text: t.button.text ?? "Copy code" }
+      ]
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  twilio
+});

package/dist/adapters/twilio.d.cts

@@ -0,0 +1,16 @@
+import { Adapter } from '../index.cjs';
+
+type TwilioOptions = {
+    /** Default: `$TWILIO_ACCOUNT_SID`. */
+    accountSid?: string;
+    /** Default: `$TWILIO_AUTH_TOKEN`. */
+    authToken?: string;
+};
+/**
+ * Twilio Content API: creates the content, then asks WhatsApp to approve it.
+ * Unverified: built from Twilio's docs, not yet run against a real account.
+ */
+declare const twilio: (options?: TwilioOptions | undefined) => Adapter;
+
+export { twilio };
+export type { TwilioOptions };

package/dist/adapters/twilio.d.ts

@@ -0,0 +1,16 @@
+import { Adapter } from '../index.js';
+
+type TwilioOptions = {
+    /** Default: `$TWILIO_ACCOUNT_SID`. */
+    accountSid?: string;
+    /** Default: `$TWILIO_AUTH_TOKEN`. */
+    authToken?: string;
+};
+/**
+ * Twilio Content API: creates the content, then asks WhatsApp to approve it.
+ * Unverified: built from Twilio's docs, not yet run against a real account.
+ */
+declare const twilio: (options?: TwilioOptions | undefined) => Adapter;
+
+export { twilio };
+export type { TwilioOptions };

package/dist/adapters/twilio.js

@@ -0,0 +1,124 @@
+import {
+  extractVariables,
+  replacePlaceholders
+} from "../chunk-SMN4WTO3.js";
+import {
+  defineAdapter,
+  unsupported
+} from "../chunk-ULTGMISN.js";
+
+// src/adapters/twilio.ts
+var NAME = "twilio";
+var CONTENT_SID = "$CONTENT_SID";
+var twilio = defineAdapter({
+  name: NAME,
+  toRequests(template, { accountSid = "$TWILIO_ACCOUNT_SID", authToken = "$TWILIO_AUTH_TOKEN" }) {
+    if (template.messageSendTtlSeconds !== void 0)
+      unsupported(NAME, "messageSendTtlSeconds", "A message TTL");
+    const credentials = accountSid.startsWith("$") || authToken.startsWith("$") ? `$(printf %s ${accountSid}:${authToken} | base64)` : btoa(`${accountSid}:${authToken}`);
+    const headers = {
+      Authorization: `Basic ${credentials}`,
+      "Content-Type": "application/json"
+    };
+    const order = extractVariables(template);
+    return [
+      {
+        method: "POST",
+        url: "https://content.twilio.com/v1/Content",
+        headers,
+        body: {
+          friendly_name: template.name,
+          language: template.language,
+          variables: order.length ? Object.fromEntries(
+            order.map((name, index) => [
+              String(index + 1),
+              template.category === "AUTHENTICATION" ? void 0 : template.variables?.[name]?.example
+            ])
+          ) : void 0,
+          types: template.category === "AUTHENTICATION" ? authentication(template) : standard(template, positional(order))
+        }
+      },
+      {
+        method: "POST",
+        url: `https://content.twilio.com/v1/Content/${CONTENT_SID}/ApprovalRequests/whatsapp`,
+        headers,
+        body: { name: template.name, category: template.category },
+        comments: [
+          `Replace ${CONTENT_SID} with the "sid" returned by the request above.`
+        ]
+      }
+    ];
+  }
+});
+var positional = (order) => (text) => replacePlaceholders(text, (name) => `{{${order.indexOf(name) + 1}}}`);
+function standard(t, pos) {
+  if (t.limitedTimeOffer)
+    unsupported(NAME, "limitedTimeOffer", "A limited-time offer");
+  if (t.callPermissionRequest)
+    unsupported(NAME, "callPermissionRequest", "A call permission request");
+  if (t.displayFormat)
+    unsupported(NAME, "displayFormat", "The ORDER_DETAILS display format");
+  const body = pos(t.body.text);
+  if (t.carousel)
+    return {
+      "twilio/carousel": {
+        body,
+        cards: t.carousel.cards.map((card, index) => {
+          const path = `carousel.cards.${index}`;
+          if (card.header.type === "PRODUCT")
+            unsupported(NAME, `${path}.header`, "A PRODUCT card header");
+          return {
+            body: card.body && pos(card.body.text),
+            media: "url" in card.header ? card.header.url : void 0,
+            actions: actions(card.buttons ?? [], pos, `${path}.buttons`)
+          };
+        })
+      }
+    };
+  const header = t.header;
+  if (header && !["TEXT", "IMAGE", "VIDEO", "DOCUMENT"].includes(header.type))
+    unsupported(NAME, "header", `A ${header.type} header`);
+  if (!header && !t.footer && !t.buttons?.length)
+    return { "twilio/text": { body } };
+  return {
+    "whatsapp/card": {
+      body,
+      header_text: header?.type === "TEXT" ? pos(header.text) : void 0,
+      media: header && "url" in header ? [header.url] : void 0,
+      footer: t.footer?.text,
+      actions: t.buttons?.length ? actions(t.buttons, pos, "buttons") : void 0
+    }
+  };
+}
+function actions(buttons, pos, path) {
+  return buttons.map((b, index) => {
+    switch (b.type) {
+      case "QUICK_REPLY":
+        return { type: b.type, title: b.text, id: b.text };
+      case "URL":
+        return { type: b.type, title: b.text, url: pos(b.url) };
+      case "PHONE_NUMBER":
+        return { type: b.type, title: b.text, phone: b.phoneNumber };
+      case "COPY_CODE":
+        return { type: b.type, code: b.example };
+      default:
+        return unsupported(NAME, `${path}.${index}`, `The ${b.type} button`);
+    }
+  });
+}
+function authentication(t) {
+  if (t.button.otpType !== "COPY_CODE")
+    unsupported(NAME, "button.otpType", `The ${t.button.otpType} OTP button`);
+  return {
+    "whatsapp/authentication": {
+      add_security_recommendation: t.body?.addSecurityRecommendation,
+      code_expiration_minutes: t.footer?.codeExpirationMinutes,
+      actions: [
+        { type: "COPY_CODE", copy_code_text: t.button.text ?? "Copy code" }
+      ]
+    }
+  };
+}
+export {
+  twilio
+};

package/dist/chunk-SMN4WTO3.js

@@ -0,0 +1,46 @@
+import {
+  placeholders
+} from "./chunk-ULTGMISN.js";
+
+// src/variables.ts
+function textFields(template) {
+  if (template.category === "AUTHENTICATION") return [];
+  const fields = [];
+  if (template.header?.type === "TEXT")
+    fields.push({ path: "header.text", text: template.header.text });
+  fields.push({ path: "body.text", text: template.body.text });
+  template.carousel?.cards.forEach((card, index) => {
+    if (card.body)
+      fields.push({
+        path: `carousel.cards.${index}.body.text`,
+        text: card.body.text
+      });
+  });
+  template.buttons?.forEach((button, index) => {
+    if (button.type === "URL")
+      fields.push({ path: `buttons.${index}.url`, text: button.url });
+  });
+  template.carousel?.cards.forEach((card, cardIndex) => {
+    card.buttons?.forEach((button, index) => {
+      if (button.type === "URL")
+        fields.push({
+          path: `carousel.cards.${cardIndex}.buttons.${index}.url`,
+          text: button.url
+        });
+    });
+  });
+  return fields;
+}
+var replacePlaceholders = (text, replace) => text.replace(/\{\{(.*?)\}\}/g, (_, name) => replace(name));
+function extractVariables(template) {
+  const names = textFields(template).flatMap(
+    (field) => placeholders(field.text).map((p) => p.name)
+  );
+  return [...new Set(names)];
+}
+
+export {
+  textFields,
+  replacePlaceholders,
+  extractVariables
+};

package/dist/chunk-ULTGMISN.js

@@ -0,0 +1,70 @@
+// src/validate/text.ts
+var PLACEHOLDER = /\{\{(.*?)\}\}/g;
+var VARIABLE_NAME = /^[a-z][a-z0-9_]*$/;
+var INVISIBLE = /[\p{Default_Ignorable_Code_Point}\u2800]/gu;
+var THAI_LAO = /[\u0E00-\u0E7F]/g;
+var CJK = /[\p{Script=Han}\p{Script=Hiragana}\p{Script=Katakana}\p{Script=Hangul}]/gu;
+var EMOJI = /\p{Regional_Indicator}{2}|\p{Extended_Pictographic}(?:\uFE0F|\p{Emoji_Modifier})*(?:\u200D\p{Extended_Pictographic}(?:\uFE0F|\p{Emoji_Modifier})*)*/gu;
+var MARKUP = /\*[^*\n]+\*|_[^_\n]+_|~[^~\n]+~|```[^`]+```/;
+function placeholders(text) {
+  return [...text.matchAll(PLACEHOLDER)].map((match) => {
+    const name = match[1] ?? "";
+    return { raw: match[0], name, valid: VARIABLE_NAME.test(name) };
+  });
+}
+var length = (text) => [...text].length;
+var countEmoji = (text) => text.match(EMOJI)?.length ?? 0;
+var hasMarkup = (text) => text.includes("*") || MARKUP.test(text);
+function countWords(text) {
+  const clean = text.replace(INVISIBLE, "");
+  const params = placeholders(clean).length;
+  const thai = clean.match(THAI_LAO)?.length ?? 0;
+  if (thai > 0) return Math.ceil(thai / 7) + params;
+  const cjk = clean.match(CJK)?.length ?? 0;
+  if (cjk > 0) return cjk + params;
+  return clean.match(/\S+/g)?.length ?? 0;
+}
+var EDGE_START = /^[\s*_~`]*\{\{[^}]*\}\}/;
+var EDGE_END = /\{\{[^}]*\}\}[\s*_~`]*!*\.*\?*[\s*_~`]*$/;
+var ADJACENT = /\{\{[^}]*\}\}[\s*_~`]*\{\{[^}]*\}\}/;
+var startsOrEndsWithPlaceholder = (text) => EDGE_START.test(text) || EDGE_END.test(text);
+var hasAdjacentPlaceholders = (text) => ADJACENT.test(text);
+
+// 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.`
+  );
+}
+
+export {
+  placeholders,
+  length,
+  countEmoji,
+  hasMarkup,
+  countWords,
+  startsOrEndsWithPlaceholder,
+  hasAdjacentPlaceholders,
+  defineAdapter,
+  UnsupportedByProviderError,
+  unsupported
+};