@ganju/utils 0.0.18 → 0.0.20

package/dist/sdkConstants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdkConstants.d.ts","sourceRoot":"","sources":["../src/sdkConstants.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,yBAAyB,qBAAqB,CAAC;AAC5D,eAAO,MAAM,0BAA0B,iBAAiB,CAAC;AAKzD,eAAO,MAAM,yBAAyB,kCAAkC,CAAC;AACzE,eAAO,MAAM,kCAAkC,gBAAgB,CAAC;AAChE,eAAO,MAAM,8BAA8B,YAAY,CAAC;AACxD,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,sCAAsC,oBAAoB,CAAC;AACxE,eAAO,MAAM,sCAAsC,oBAAoB,CAAC;AACxE,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,iCAAiC,eAAe,CAAC;AAC9D,eAAO,MAAM,4BAA4B,UAAU,CAAC;AACpD,eAAO,MAAM,qCAAqC,mBAAmB,CAAC;AACtE,eAAO,MAAM,qCAAqC,mBAAmB,CAAC;AAYtE,eAAO,MAAM,2BAA2B,yBAAyB,CAAC;AAOlE,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AAKxD,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,0BAA0B,OAAQ,CAAC"}
+{"version":3,"file":"sdkConstants.d.ts","sourceRoot":"","sources":["../src/sdkConstants.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,yBAAyB,qBAAqB,CAAC;AAC5D,eAAO,MAAM,0BAA0B,iBAAiB,CAAC;AAKzD,eAAO,MAAM,yBAAyB,kCAAkC,CAAC;AACzE,eAAO,MAAM,kCAAkC,gBAAgB,CAAC;AAChE,eAAO,MAAM,8BAA8B,YAAY,CAAC;AACxD,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,sCAAsC,oBAAoB,CAAC;AACxE,eAAO,MAAM,sCAAsC,oBAAoB,CAAC;AACxE,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,wCAAwC,sBAAsB,CAAC;AAC5E,eAAO,MAAM,iCAAiC,eAAe,CAAC;AAC9D,eAAO,MAAM,4BAA4B,UAAU,CAAC;AACpD,eAAO,MAAM,qCAAqC,mBAAmB,CAAC;AACtE,eAAO,MAAM,qCAAqC,mBAAmB,CAAC;AACtE,eAAO,MAAM,0CAA0C,wBAAwB,CAAC;AAYhF,eAAO,MAAM,2BAA2B,yBAAyB,CAAC;AAOlE,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AAKxD,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,0BAA0B,OAAQ,CAAC"}

package/dist/sdkConstants.js

@@ -11,7 +11,7 @@
 // The rule for this file: nothing lands here unless the SDK reads it at runtime,
 // and it imports nothing.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUSTOM_CODE_MAX_LOG_LENGTH = exports.CUSTOM_CODE_MAX_LOGS = exports.CUSTOM_CODE_HEALTH_TOOL = exports.CUSTOM_CODE_BINDING_VERSION = exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_POST = exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND = exports.CUSTOM_CODE_BROKER_PATH_DATA = exports.CUSTOM_CODE_BROKER_PATH_SEND_FILE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_DELETE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_CREATE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_LIST = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_READ = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_SEARCH = exports.CUSTOM_CODE_BROKER_PATH_SECRET = exports.CUSTOM_CODE_BROKER_PATH_CONNECTION = exports.CUSTOM_CODE_BROKER_ORIGIN = exports.CUSTOM_CODE_BINDING_BROKER = exports.CUSTOM_CODE_BINDING_TOKEN = void 0;
+exports.CUSTOM_CODE_MAX_LOG_LENGTH = exports.CUSTOM_CODE_MAX_LOGS = exports.CUSTOM_CODE_HEALTH_TOOL = exports.CUSTOM_CODE_BINDING_VERSION = exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_TEMPLATES = exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_POST = exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND = exports.CUSTOM_CODE_BROKER_PATH_DATA = exports.CUSTOM_CODE_BROKER_PATH_SEND_FILE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_DELETE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_CREATE = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_LIST = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_READ = exports.CUSTOM_CODE_BROKER_PATH_RESOURCES_SEARCH = exports.CUSTOM_CODE_BROKER_PATH_SECRET = exports.CUSTOM_CODE_BROKER_PATH_CONNECTION = exports.CUSTOM_CODE_BROKER_ORIGIN = exports.CUSTOM_CODE_BINDING_BROKER = exports.CUSTOM_CODE_BINDING_TOKEN = void 0;
 // Bindings injected into every user script at upload time. The token is a
 // secret_text binding rotated on each publish; the broker is a service binding.
 // Names are part of the SDK's contract with the script, so they can't be
@@ -33,6 +33,7 @@ exports.CUSTOM_CODE_BROKER_PATH_SEND_FILE = '/send-file';
 exports.CUSTOM_CODE_BROKER_PATH_DATA = '/data';
 exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND = '/channels/send';
 exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_POST = '/channels/post';
+exports.CUSTOM_CODE_BROKER_PATH_CHANNELS_TEMPLATES = '/channels/templates';
 // Injected at upload time and echoed back by the health probe below. Uploading a
 // script into the dispatch namespace is not read-your-writes: dispatching to the
 // name immediately afterwards can still reach the previous edition. Tool names

package/dist/whatsappTemplates.d.ts

@@ -0,0 +1,77 @@
+export declare const WHATSAPP_TEMPLATE_CATEGORIES: readonly ["UTILITY", "MARKETING"];
+export type WhatsappTemplateCategory = (typeof WHATSAPP_TEMPLATE_CATEGORIES)[number];
+export declare const WHATSAPP_TEMPLATE_STATUS_APPROVED = "APPROVED";
+export declare const WHATSAPP_TEMPLATE_STATUSES_WAITING: string[];
+export declare const WHATSAPP_TEMPLATE_STATUSES_STOPPED: string[];
+export declare const WHATSAPP_TEMPLATE_NAME_MAX = 512;
+export declare const WHATSAPP_TEMPLATE_BODY_MAX = 1024;
+export declare const WHATSAPP_TEMPLATE_HEADER_MAX = 60;
+export declare const WHATSAPP_TEMPLATE_FOOTER_MAX = 60;
+export declare const WHATSAPP_TEMPLATE_BUTTON_MAX = 25;
+export declare const WHATSAPP_TEMPLATE_BUTTONS_MAX = 10;
+export declare const WHATSAPP_TEMPLATE_VARIABLES_MAX = 20;
+export declare const WHATSAPP_TEMPLATE_LABEL_MAX = 40;
+export declare const WHATSAPP_TEMPLATE_EXAMPLE_MAX = 200;
+export declare const WHATSAPP_TEMPLATE_LANGUAGES: {
+    code: string;
+    name: string;
+}[];
+/** A template as the owner writes it. `examples[i]` and `labels[i]` are {{i+1}}'s. */
+export interface WhatsappTemplateDraft {
+    name: string;
+    language: string;
+    category: WhatsappTemplateCategory;
+    header?: string | null;
+    body: string;
+    footer?: string | null;
+    buttons?: string[];
+    examples?: string[];
+    labels?: string[];
+}
+/** A template's text, read back from Meta's components. */
+export interface WhatsappTemplateContent {
+    header: string | null;
+    body: string;
+    footer: string | null;
+    buttons: string[];
+    examples: string[];
+}
+export type WhatsappTemplateIssueCode = 'name_format' | 'name_long' | 'language' | 'category' | 'body_empty' | 'body_long' | 'header_long' | 'header_variables' | 'header_lines' | 'footer_long' | 'footer_variables' | 'button_empty' | 'button_long' | 'button_variables' | 'buttons_many' | 'buttons_repeated' | 'variables_many' | 'variables_order' | 'variable_at_start' | 'variable_at_end' | 'variables_adjacent' | 'variables_dense' | 'example_missing';
+export interface WhatsappTemplateIssue {
+    code: WhatsappTemplateIssueCode;
+    n?: number;
+}
+/** Each {{n}} in the text, in the order they appear. */
+export declare const whatsappTemplateVariables: (text: string) => number[];
+/** How many variables the body has: its highest {{n}}. */
+export declare const whatsappTemplateVariableCount: (body: string) => number;
+/**
+ * The rules Meta rejects templates for most often, checked before sending
+ * one for review. Meta's review has the last word; this only catches the
+ * common mistakes early.
+ */
+export declare const checkWhatsappTemplate: (draft: WhatsappTemplateDraft) => WhatsappTemplateIssue[];
+export declare const whatsappTemplateIssueText: (issue: WhatsappTemplateIssue) => string;
+/** The components Meta's create and edit calls take. */
+export declare const whatsappTemplateComponents: (draft: WhatsappTemplateDraft) => Record<string, unknown>[];
+/** A template's text, from the components Meta returns. */
+export declare const whatsappTemplateContent: (components: unknown) => WhatsappTemplateContent;
+/**
+ * Whether Ganju can send it: it fills the body's variables only. A media
+ * header, a header variable, or a button that takes a value (a URL with a
+ * variable, a code, a flow) needs more, and Meta refuses the send.
+ */
+export declare const whatsappTemplateSendable: (components: unknown) => boolean;
+/** The body with each {{n}} replaced, for previews and the message record. */
+export declare const fillWhatsappTemplate: (body: string, values: string[]) => string;
+/**
+ * A value for a {{n}} as Meta accepts it: no line breaks or tabs, no long
+ * runs of spaces, and never empty.
+ */
+export declare const cleanWhatsappTemplateParam: (value: unknown) => string;
+/** A Meta send error as an owner reads it, and whether a retry may help. */
+export declare const whatsappSendError: (code: number | undefined, detail: string | undefined) => {
+    text: string;
+    retry: boolean;
+};
+//# sourceMappingURL=whatsappTemplates.d.ts.map

package/dist/whatsappTemplates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whatsappTemplates.d.ts","sourceRoot":"","sources":["../src/whatsappTemplates.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,4BAA4B,mCAAoC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC;AAGhD,eAAO,MAAM,iCAAiC,aAAa,CAAC;AAE5D,eAAO,MAAM,kCAAkC,UAI9C,CAAC;AAEF,eAAO,MAAM,kCAAkC,UAAyB,CAAC;AAEzE,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAC9C,eAAO,MAAM,0BAA0B,OAAO,CAAC;AAC/C,eAAO,MAAM,4BAA4B,KAAK,CAAC;AAC/C,eAAO,MAAM,4BAA4B,KAAK,CAAC;AAC/C,eAAO,MAAM,4BAA4B,KAAK,CAAC;AAC/C,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,+BAA+B,KAAK,CAAC;AAClD,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAC9C,eAAO,MAAM,6BAA6B,MAAM,CAAC;AAIjD,eAAO,MAAM,2BAA2B,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAwEvE,CAAC;AAEF,sFAAsF;AACtF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,wBAAwB,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,2DAA2D;AAC3D,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,MAAM,yBAAyB,GACjC,aAAa,GACb,WAAW,GACX,UAAU,GACV,UAAU,GACV,YAAY,GACZ,WAAW,GACX,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB,GACpB,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,yBAAyB,CAAC;IAEhC,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAID,wDAAwD;AACxD,eAAO,MAAM,yBAAyB,GAAI,MAAM,MAAM,KAAG,MAAM,EACC,CAAC;AAEjE,0DAA0D;AAC1D,eAAO,MAAM,6BAA6B,GAAI,MAAM,MAAM,KAAG,MACZ,CAAC;AAQlD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAChC,OAAO,qBAAqB,KAC3B,qBAAqB,EA0DvB,CAAC;AA+BF,eAAO,MAAM,yBAAyB,GAAI,OAAO,qBAAqB,WAGrB,CAAC;AAElD,wDAAwD;AACxD,eAAO,MAAM,0BAA0B,GACrC,OAAO,qBAAqB,KAC3B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EA+BzB,CAAC;AAEF,2DAA2D;AAC3D,eAAO,MAAM,uBAAuB,GAClC,YAAY,OAAO,KAClB,uBA6BF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GAAI,YAAY,OAAO,KAAG,OA4B9D,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,EAAE,QAAQ,MAAM,EAAE,KAAG,MACA,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,MAO3D,CAAC;AA0DF,4EAA4E;AAC5E,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,GAAG,SAAS,EACxB,QAAQ,MAAM,GAAG,SAAS,KACzB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAOhC,CAAC"}

package/dist/whatsappTemplates.js

@@ -0,0 +1,402 @@
+"use strict";
+// WhatsApp message templates: the shape Meta's Graph API takes and returns,
+// and the rules it rejects templates for most often, checked before one is
+// sent for review. Imports nothing, so the dashboard runs the same checks.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.whatsappSendError = exports.cleanWhatsappTemplateParam = exports.fillWhatsappTemplate = exports.whatsappTemplateSendable = exports.whatsappTemplateContent = exports.whatsappTemplateComponents = exports.whatsappTemplateIssueText = exports.checkWhatsappTemplate = exports.whatsappTemplateVariableCount = exports.whatsappTemplateVariables = exports.WHATSAPP_TEMPLATE_LANGUAGES = exports.WHATSAPP_TEMPLATE_EXAMPLE_MAX = exports.WHATSAPP_TEMPLATE_LABEL_MAX = exports.WHATSAPP_TEMPLATE_VARIABLES_MAX = exports.WHATSAPP_TEMPLATE_BUTTONS_MAX = exports.WHATSAPP_TEMPLATE_BUTTON_MAX = exports.WHATSAPP_TEMPLATE_FOOTER_MAX = exports.WHATSAPP_TEMPLATE_HEADER_MAX = exports.WHATSAPP_TEMPLATE_BODY_MAX = exports.WHATSAPP_TEMPLATE_NAME_MAX = exports.WHATSAPP_TEMPLATE_STATUSES_STOPPED = exports.WHATSAPP_TEMPLATE_STATUSES_WAITING = exports.WHATSAPP_TEMPLATE_STATUS_APPROVED = exports.WHATSAPP_TEMPLATE_CATEGORIES = void 0;
+exports.WHATSAPP_TEMPLATE_CATEGORIES = ['UTILITY', 'MARKETING'];
+// What Meta reports. Only APPROVED templates can be sent.
+exports.WHATSAPP_TEMPLATE_STATUS_APPROVED = 'APPROVED';
+// Still in Meta's hands: the hourly sync looks at these again.
+exports.WHATSAPP_TEMPLATE_STATUSES_WAITING = [
+    'PENDING',
+    'IN_APPEAL',
+    'PENDING_DELETION'
+];
+// An approved template Meta stopped: its owners are told.
+exports.WHATSAPP_TEMPLATE_STATUSES_STOPPED = ['PAUSED', 'DISABLED'];
+exports.WHATSAPP_TEMPLATE_NAME_MAX = 512;
+exports.WHATSAPP_TEMPLATE_BODY_MAX = 1024;
+exports.WHATSAPP_TEMPLATE_HEADER_MAX = 60;
+exports.WHATSAPP_TEMPLATE_FOOTER_MAX = 60;
+exports.WHATSAPP_TEMPLATE_BUTTON_MAX = 25;
+exports.WHATSAPP_TEMPLATE_BUTTONS_MAX = 10;
+exports.WHATSAPP_TEMPLATE_VARIABLES_MAX = 20;
+exports.WHATSAPP_TEMPLATE_LABEL_MAX = 40;
+exports.WHATSAPP_TEMPLATE_EXAMPLE_MAX = 200;
+const NAME_PATTERN = /^[a-z0-9_]+$/;
+// Meta's template languages. The first ones are the ones most owners use.
+exports.WHATSAPP_TEMPLATE_LANGUAGES = [
+    { code: 'es', name: 'Spanish' },
+    { code: 'es_MX', name: 'Spanish (Mexico)' },
+    { code: 'es_AR', name: 'Spanish (Argentina)' },
+    { code: 'es_ES', name: 'Spanish (Spain)' },
+    { code: 'en', name: 'English' },
+    { code: 'en_US', name: 'English (US)' },
+    { code: 'en_GB', name: 'English (UK)' },
+    { code: 'pt_BR', name: 'Portuguese (Brazil)' },
+    { code: 'pt_PT', name: 'Portuguese (Portugal)' },
+    { code: 'af', name: 'Afrikaans' },
+    { code: 'sq', name: 'Albanian' },
+    { code: 'ar', name: 'Arabic' },
+    { code: 'az', name: 'Azerbaijani' },
+    { code: 'bn', name: 'Bengali' },
+    { code: 'bg', name: 'Bulgarian' },
+    { code: 'ca', name: 'Catalan' },
+    { code: 'zh_CN', name: 'Chinese (China)' },
+    { code: 'zh_HK', name: 'Chinese (Hong Kong)' },
+    { code: 'zh_TW', name: 'Chinese (Taiwan)' },
+    { code: 'hr', name: 'Croatian' },
+    { code: 'cs', name: 'Czech' },
+    { code: 'da', name: 'Danish' },
+    { code: 'nl', name: 'Dutch' },
+    { code: 'et', name: 'Estonian' },
+    { code: 'fil', name: 'Filipino' },
+    { code: 'fi', name: 'Finnish' },
+    { code: 'fr', name: 'French' },
+    { code: 'ka', name: 'Georgian' },
+    { code: 'de', name: 'German' },
+    { code: 'el', name: 'Greek' },
+    { code: 'gu', name: 'Gujarati' },
+    { code: 'ha', name: 'Hausa' },
+    { code: 'he', name: 'Hebrew' },
+    { code: 'hi', name: 'Hindi' },
+    { code: 'hu', name: 'Hungarian' },
+    { code: 'id', name: 'Indonesian' },
+    { code: 'ga', name: 'Irish' },
+    { code: 'it', name: 'Italian' },
+    { code: 'ja', name: 'Japanese' },
+    { code: 'kn', name: 'Kannada' },
+    { code: 'kk', name: 'Kazakh' },
+    { code: 'rw_RW', name: 'Kinyarwanda' },
+    { code: 'ko', name: 'Korean' },
+    { code: 'ky_KG', name: 'Kyrgyz' },
+    { code: 'lo', name: 'Lao' },
+    { code: 'lv', name: 'Latvian' },
+    { code: 'lt', name: 'Lithuanian' },
+    { code: 'mk', name: 'Macedonian' },
+    { code: 'ms', name: 'Malay' },
+    { code: 'ml', name: 'Malayalam' },
+    { code: 'mr', name: 'Marathi' },
+    { code: 'nb', name: 'Norwegian' },
+    { code: 'fa', name: 'Persian' },
+    { code: 'pl', name: 'Polish' },
+    { code: 'pa', name: 'Punjabi' },
+    { code: 'ro', name: 'Romanian' },
+    { code: 'ru', name: 'Russian' },
+    { code: 'sr', name: 'Serbian' },
+    { code: 'sk', name: 'Slovak' },
+    { code: 'sl', name: 'Slovenian' },
+    { code: 'sw', name: 'Swahili' },
+    { code: 'sv', name: 'Swedish' },
+    { code: 'ta', name: 'Tamil' },
+    { code: 'te', name: 'Telugu' },
+    { code: 'th', name: 'Thai' },
+    { code: 'tr', name: 'Turkish' },
+    { code: 'uk', name: 'Ukrainian' },
+    { code: 'ur', name: 'Urdu' },
+    { code: 'uz', name: 'Uzbek' },
+    { code: 'vi', name: 'Vietnamese' },
+    { code: 'zu', name: 'Zulu' }
+];
+const VARIABLE = /\{\{\s*(\d+)\s*\}\}/g;
+/** Each {{n}} in the text, in the order they appear. */
+const whatsappTemplateVariables = (text) => Array.from(text.matchAll(VARIABLE), match => Number(match[1]));
+exports.whatsappTemplateVariables = whatsappTemplateVariables;
+/** How many variables the body has: its highest {{n}}. */
+const whatsappTemplateVariableCount = (body) => Math.max(0, ...(0, exports.whatsappTemplateVariables)(body));
+exports.whatsappTemplateVariableCount = whatsappTemplateVariableCount;
+const words = (text) => text
+    .replace(VARIABLE, ' ')
+    .split(/\s+/)
+    .filter(word => /[\p{L}\p{N}]/u.test(word)).length;
+/**
+ * The rules Meta rejects templates for most often, checked before sending
+ * one for review. Meta's review has the last word; this only catches the
+ * common mistakes early.
+ */
+const checkWhatsappTemplate = (draft) => {
+    const issues = [];
+    const add = (code, n) => issues.push(n === undefined ? { code } : { code, n });
+    if (!NAME_PATTERN.test(draft.name))
+        add('name_format');
+    if (draft.name.length > exports.WHATSAPP_TEMPLATE_NAME_MAX)
+        add('name_long');
+    if (!exports.WHATSAPP_TEMPLATE_LANGUAGES.some(l => l.code === draft.language)) {
+        add('language');
+    }
+    if (!exports.WHATSAPP_TEMPLATE_CATEGORIES.includes(draft.category))
+        add('category');
+    const header = draft.header?.trim() ?? '';
+    if (header.length > exports.WHATSAPP_TEMPLATE_HEADER_MAX)
+        add('header_long');
+    if ((0, exports.whatsappTemplateVariables)(header).length > 0)
+        add('header_variables');
+    if (/[\n\r]/.test(header))
+        add('header_lines');
+    const footer = draft.footer?.trim() ?? '';
+    if (footer.length > exports.WHATSAPP_TEMPLATE_FOOTER_MAX)
+        add('footer_long');
+    if ((0, exports.whatsappTemplateVariables)(footer).length > 0)
+        add('footer_variables');
+    const buttons = draft.buttons ?? [];
+    if (buttons.length > exports.WHATSAPP_TEMPLATE_BUTTONS_MAX)
+        add('buttons_many');
+    if (buttons.some(button => !button.trim()))
+        add('button_empty');
+    if (buttons.some(button => button.trim().length > exports.WHATSAPP_TEMPLATE_BUTTON_MAX)) {
+        add('button_long');
+    }
+    if (buttons.some(button => (0, exports.whatsappTemplateVariables)(button).length > 0)) {
+        add('button_variables');
+    }
+    const unique = new Set(buttons.map(button => button.trim().toLowerCase()));
+    if (unique.size < buttons.length)
+        add('buttons_repeated');
+    const body = draft.body.trim();
+    if (!body) {
+        add('body_empty');
+        return issues;
+    }
+    if (body.length > exports.WHATSAPP_TEMPLATE_BODY_MAX)
+        add('body_long');
+    const found = (0, exports.whatsappTemplateVariables)(body);
+    if (found.length === 0)
+        return issues;
+    const count = Math.max(...found);
+    if (count > exports.WHATSAPP_TEMPLATE_VARIABLES_MAX)
+        add('variables_many');
+    // {{1}}, {{2}}, … with no gaps, each first used after the one before.
+    const firsts = [...new Set(found)];
+    if (firsts.some((n, i) => n !== i + 1))
+        add('variables_order');
+    if (/^\{\{\s*\d+\s*\}\}/.test(body))
+        add('variable_at_start');
+    if (/\{\{\s*\d+\s*\}\}[\s.!?…]*$/.test(body))
+        add('variable_at_end');
+    if (/\}\}\s*\{\{/.test(body))
+        add('variables_adjacent');
+    // Meta wants more words than variables; this is about the ratio it accepts.
+    if (words(body) < 2 * firsts.length + 1)
+        add('variables_dense');
+    const examples = draft.examples ?? [];
+    for (let n = 1; n <= count; n++) {
+        if (!examples[n - 1]?.trim())
+            add('example_missing', n);
+    }
+    return issues;
+};
+exports.checkWhatsappTemplate = checkWhatsappTemplate;
+const ISSUE_TEXT = {
+    name_format: 'The name takes lowercase letters, digits and underscores only.',
+    name_long: `The name is at most ${exports.WHATSAPP_TEMPLATE_NAME_MAX} characters.`,
+    language: "The language isn't one Meta supports.",
+    category: 'The category is Utility or Marketing.',
+    body_empty: 'The message needs a body.',
+    body_long: `The body is at most ${exports.WHATSAPP_TEMPLATE_BODY_MAX} characters.`,
+    header_long: `The header is at most ${exports.WHATSAPP_TEMPLATE_HEADER_MAX} characters.`,
+    header_variables: "The header can't have variables.",
+    header_lines: 'The header is one line.',
+    footer_long: `The footer is at most ${exports.WHATSAPP_TEMPLATE_FOOTER_MAX} characters.`,
+    footer_variables: "The footer can't have variables.",
+    button_empty: 'A quick reply needs a text.',
+    button_long: `A quick reply is at most ${exports.WHATSAPP_TEMPLATE_BUTTON_MAX} characters.`,
+    button_variables: "A quick reply can't have variables.",
+    buttons_many: `At most ${exports.WHATSAPP_TEMPLATE_BUTTONS_MAX} quick replies.`,
+    buttons_repeated: 'Two quick replies say the same.',
+    variables_many: `At most ${exports.WHATSAPP_TEMPLATE_VARIABLES_MAX} variables.`,
+    variables_order: 'Variables are numbered {{1}}, {{2}}, … in the order they first appear, with no gaps.',
+    variable_at_start: 'Meta rejects a body that starts with a variable.',
+    variable_at_end: 'Meta rejects a body that ends with a variable.',
+    variables_adjacent: 'Meta rejects two variables side by side; put words between them.',
+    variables_dense: 'Too many variables for the length of the text; add words or remove variables.',
+    example_missing: 'Each variable needs an example value for Meta to review.'
+};
+const whatsappTemplateIssueText = (issue) => issue.n === undefined
+    ? ISSUE_TEXT[issue.code]
+    : `{{${issue.n}}}: ${ISSUE_TEXT[issue.code]}`;
+exports.whatsappTemplateIssueText = whatsappTemplateIssueText;
+/** The components Meta's create and edit calls take. */
+const whatsappTemplateComponents = (draft) => {
+    const components = [];
+    const header = draft.header?.trim();
+    if (header)
+        components.push({ type: 'HEADER', format: 'TEXT', text: header });
+    const body = draft.body.trim();
+    const count = (0, exports.whatsappTemplateVariableCount)(body);
+    components.push({
+        type: 'BODY',
+        text: body,
+        ...(count > 0
+            ? {
+                example: {
+                    body_text: [
+                        Array.from({ length: count }, (_, i) => (draft.examples?.[i] ?? '').trim())
+                    ]
+                }
+            }
+            : {})
+    });
+    const footer = draft.footer?.trim();
+    if (footer)
+        components.push({ type: 'FOOTER', text: footer });
+    const buttons = (draft.buttons ?? []).map(b => b.trim()).filter(Boolean);
+    if (buttons.length > 0) {
+        components.push({
+            type: 'BUTTONS',
+            buttons: buttons.map(text => ({ type: 'QUICK_REPLY', text }))
+        });
+    }
+    return components;
+};
+exports.whatsappTemplateComponents = whatsappTemplateComponents;
+/** A template's text, from the components Meta returns. */
+const whatsappTemplateContent = (components) => {
+    const content = {
+        header: null,
+        body: '',
+        footer: null,
+        buttons: [],
+        examples: []
+    };
+    if (!Array.isArray(components))
+        return content;
+    for (const component of components) {
+        const type = String(component?.type ?? '').toUpperCase();
+        const text = typeof component?.text === 'string' ? component.text : null;
+        if (type === 'HEADER' && component.format === 'TEXT')
+            content.header = text;
+        if (type === 'BODY') {
+            content.body = text ?? '';
+            const example = component.example;
+            const first = example?.body_text?.[0];
+            if (Array.isArray(first))
+                content.examples = first.map(v => String(v));
+        }
+        if (type === 'FOOTER')
+            content.footer = text;
+        if (type === 'BUTTONS' && Array.isArray(component.buttons)) {
+            content.buttons = component.buttons
+                .filter(b => b?.type === 'QUICK_REPLY' && typeof b.text === 'string')
+                .map(b => b.text);
+        }
+    }
+    return content;
+};
+exports.whatsappTemplateContent = whatsappTemplateContent;
+/**
+ * Whether Ganju can send it: it fills the body's variables only. A media
+ * header, a header variable, or a button that takes a value (a URL with a
+ * variable, a code, a flow) needs more, and Meta refuses the send.
+ */
+const whatsappTemplateSendable = (components) => {
+    if (!Array.isArray(components))
+        return false;
+    return components.every(component => {
+        const type = String(component?.type ?? '').toUpperCase();
+        if (type === 'BODY' || type === 'FOOTER')
+            return true;
+        if (type === 'HEADER') {
+            return (component.format === 'TEXT' &&
+                (0, exports.whatsappTemplateVariables)(String(component.text ?? '')).length === 0);
+        }
+        if (type === 'BUTTONS') {
+            const buttons = Array.isArray(component.buttons)
+                ? component.buttons
+                : [];
+            return buttons.every(button => {
+                const kind = String(button?.type ?? '').toUpperCase();
+                if (kind === 'QUICK_REPLY' || kind === 'PHONE_NUMBER')
+                    return true;
+                if (kind === 'URL') {
+                    return ((0, exports.whatsappTemplateVariables)(String(button.url ?? '')).length === 0);
+                }
+                return false;
+            });
+        }
+        return false;
+    });
+};
+exports.whatsappTemplateSendable = whatsappTemplateSendable;
+/** The body with each {{n}} replaced, for previews and the message record. */
+const fillWhatsappTemplate = (body, values) => body.replace(VARIABLE, (whole, n) => values[Number(n) - 1] ?? whole);
+exports.fillWhatsappTemplate = fillWhatsappTemplate;
+/**
+ * A value for a {{n}} as Meta accepts it: no line breaks or tabs, no long
+ * runs of spaces, and never empty.
+ */
+const cleanWhatsappTemplateParam = (value) => {
+    const text = String(value ?? '')
+        .replace(/[\r\n\t]+/g, ' ')
+        .replace(/ {2,}/g, ' ')
+        .trim()
+        .slice(0, 1024);
+    return text || '-';
+};
+exports.cleanWhatsappTemplateParam = cleanWhatsappTemplateParam;
+// Meta's error codes for a message that didn't go out, in words an owner can
+// act on. `retry`: the same message may go through later.
+const SEND_ERRORS = {
+    1: { text: 'WhatsApp had a temporary problem.', retry: true },
+    2: { text: 'WhatsApp had a temporary problem.', retry: true },
+    10: { text: "The channel's access token isn't allowed to send messages." },
+    190: {
+        text: "The channel's access token expired or was revoked; connect a new one in the channel's settings."
+    },
+    200: { text: "The channel's access token isn't allowed to send messages." },
+    368: {
+        text: 'Meta has temporarily blocked this WhatsApp Business account for policy violations.'
+    },
+    130429: {
+        text: "The number's sending rate was reached; it will be tried again.",
+        retry: true
+    },
+    131000: { text: 'WhatsApp had a temporary problem.', retry: true },
+    131016: { text: 'WhatsApp is temporarily unavailable.', retry: true },
+    131026: {
+        text: "WhatsApp couldn't deliver it: the customer may have blocked the business, left WhatsApp, or not accepted its latest terms."
+    },
+    131031: { text: 'Meta locked this WhatsApp Business account.' },
+    131042: {
+        text: "Meta refused it over a payment problem on the WhatsApp Business account; check its payment method in Meta's Business settings."
+    },
+    131047: {
+        text: "Outside WhatsApp's 24-hour window: the customer last wrote more than 24 hours ago, so only an approved template reaches them."
+    },
+    131048: {
+        text: "Meta limited this number's sending because of its quality: too many customers blocked or reported its messages."
+    },
+    131049: {
+        text: 'Meta chose not to deliver this marketing message, to limit how many each customer gets.'
+    },
+    131050: {
+        text: 'The customer turned off marketing messages from this business.'
+    },
+    131056: {
+        text: 'Too many messages to this customer in a short time; it will be tried again.',
+        retry: true
+    },
+    132000: {
+        text: "The number of values doesn't match the template's variables."
+    },
+    132001: {
+        text: 'Meta has no approved template with that name in that language.'
+    },
+    132005: { text: "The template's text is too long with the values put in." },
+    132007: { text: "The template's text breaks WhatsApp's commerce policy." },
+    132012: { text: "A value doesn't match what the template expects." },
+    132015: { text: 'Meta paused this template because of its quality.' },
+    132016: { text: 'Meta disabled this template because of its quality.' },
+    132018: { text: 'A value has line breaks, tabs or too many spaces.' }
+};
+/** A Meta send error as an owner reads it, and whether a retry may help. */
+const whatsappSendError = (code, detail) => {
+    const known = code !== undefined ? SEND_ERRORS[code] : undefined;
+    if (known)
+        return { text: known.text, retry: !!known.retry };
+    return {
+        text: detail ? detail.slice(0, 300) : 'WhatsApp refused the message.',
+        retry: true
+    };
+};
+exports.whatsappSendError = whatsappSendError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ganju/utils",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "Shared constants, schemas and helpers for Ganju",
   "license": "Apache-2.0",
   "author": "MontoyaAndres <andresmontoyafcb@gmail.com>",

package/src/constants.ts

@@ -25,6 +25,7 @@ import {
   CUSTOM_CODE_BROKER_PATH_DATA,
   CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND,
   CUSTOM_CODE_BROKER_PATH_CHANNELS_POST,
+  CUSTOM_CODE_BROKER_PATH_CHANNELS_TEMPLATES,
   CUSTOM_CODE_HEALTH_TOOL,
   CUSTOM_CODE_MAX_LOGS,
   CUSTOM_CODE_MAX_LOG_LENGTH
@@ -2271,6 +2272,9 @@ interface PlanLimits {
   maxDataTablesPerDatabase: number | null;
   // Abuse backstop on data trigger runs a month. `null` = no backstop.
   triggerRunHardCap: number | null;
+  // Email trigger runs a day per organization, each to at most 10 addresses.
+  // They go out from Ganju's own domain. `null` = no cap.
+  dailyTriggerEmailCap: number | null;
 }
 
 const PLAN_LIMITS: Record<
@@ -2315,7 +2319,8 @@ const PLAN_LIMITS: Record<
     canUseData: false,
     maxDataBytes: null,
     maxDataTablesPerDatabase: null,
-    triggerRunHardCap: 0
+    triggerRunHardCap: 0,
+    dailyTriggerEmailCap: 0
   },
   PRO: {
     maxProjects: null,
@@ -2346,7 +2351,8 @@ const PLAN_LIMITS: Record<
     canUseData: true,
     maxDataBytes: DATA_MAX_DATABASE_BYTES,
     maxDataTablesPerDatabase: DATA_MAX_TABLES_PER_DATABASE,
-    triggerRunHardCap: DATA_TRIGGER_RUN_HARD_CAP
+    triggerRunHardCap: DATA_TRIGGER_RUN_HARD_CAP,
+    dailyTriggerEmailCap: 500
   },
   ENTERPRISE: {
     maxProjects: null,
@@ -2377,7 +2383,8 @@ const PLAN_LIMITS: Record<
     canUseData: true,
     maxDataBytes: DATA_MAX_DATABASE_BYTES,
     maxDataTablesPerDatabase: DATA_MAX_TABLES_PER_DATABASE,
-    triggerRunHardCap: null
+    triggerRunHardCap: null,
+    dailyTriggerEmailCap: 5000
   }
 };
 
@@ -3113,6 +3120,7 @@ export const constants = {
   CUSTOM_CODE_BROKER_PATH_DATA,
   CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND,
   CUSTOM_CODE_BROKER_PATH_CHANNELS_POST,
+  CUSTOM_CODE_BROKER_PATH_CHANNELS_TEMPLATES,
   CUSTOM_CODE_OUTBOUND_PARAM_ARTIFACT_ID,
   CUSTOM_CODE_OUTBOUND_PARAM_ALLOWED_HOSTS,
   CUSTOM_CODE_PLATFORM_HOSTS,

package/src/crypto.ts

@@ -1,6 +1,6 @@
-import { Context } from 'hono';
 import { xchacha20poly1305 } from '@noble/ciphers/chacha.js';
 import { getEnv } from './getEnv';
+import type { EnvSource } from './getEnv';
 import { base64ToBytes, bytesToBase64 } from './base64';
 
 const PREFIX = 'enc:v1:';
@@ -8,7 +8,8 @@ const NONCE_BYTES = 24;
 const KEY_BYTES = 32;
 const KEY_ENV = 'CRYPTO_SECRET';
 
-export const getCredentialEncryptionKey = (c: Context) => {
+// A request's context, or anything with the worker's env (a cron, a queue).
+export const getCredentialEncryptionKey = (c: EnvSource) => {
   const rawKey = getEnv(c, KEY_ENV);
   if (!rawKey) {
     throw new Error(`Missing env: ${KEY_ENV}`);

package/src/dataApi.ts

@@ -328,9 +328,9 @@ export const DATA_API_ROUTES = {
     tag: 'Triggers',
     summary: 'Save a trigger',
     description:
-      'Runs one action when rows of `table` are inserted, updated or deleted, and `when` holds: `{ "status": { "changedTo": "READY" } }` fires on the transition only; `changedFrom`, `changed: true` and `equals` test a column too, and `all` / `any` combine them. The action is one of `function` (a function of this project, given `{ event, table, row, previous, actor, eventId, triggerId }`), `webhook` (an https URL, sent a POST signed in `x-ganju-signature`), `chat` (`{ channelId, chatId, text }`), `email` (`{ to, subject, text }`) or `customer` (`{ text, template? }`, to the row\'s customer on a customer-scoped table). Texts take `{{field}}` from the row, inserted as plain text. Saving under an existing name replaces it, unless `replace` is false; with no `name`, it always creates a new trigger, named from the table, event and action and numbered past those taken. Left out, `enabled` keeps a saved trigger on or off as it was. A new webhook answers with its signing `secret`, shown this once. Delivery is at least once: every event carries an `eventId`.',
+      'Runs one action when rows of `table` are inserted, updated or deleted, and `when` holds: `{ "status": { "changedTo": "READY" } }` fires on the transition only; `changedFrom`, `changed: true` and `equals` test a column too, and `all` / `any` combine them. The action is one of `function` (a function of this project, given `{ event, table, row, previous, actor, eventId, triggerId }`), `webhook` (an https URL, sent a POST signed in `x-ganju-signature`), `chat` (`{ channelId, chatId, text }`), `email` (`{ to, subject, text }`) or `customer` (`{ text, template? }`, to the row\'s customer on a customer-scoped table). Texts take `{{field}}` from the row, inserted as plain text. Saving under an existing name replaces it, unless `replace` is false; with no `name`, it always creates a new trigger, named from the table, event and action and numbered past those taken. Left out, `enabled` keeps a saved trigger on or off as it was. A new webhook answers with its signing `secret`, shown this once. An `email` goes to the organization\'s members; any other address is sent a link to confirm first, and those still waiting come back as `confirming`. Delivery is at least once: every event carries an `eventId`.',
     body: DATA_TRIGGER_INPUT,
-    returns: '{ trigger, secret? }',
+    returns: '{ trigger, secret?, confirming? }',
     status: 201
   },
   updateTrigger: {
@@ -356,9 +356,9 @@ export const DATA_API_ROUTES = {
     tag: 'Triggers',
     summary: 'Deploy the triggers of ganju.json',
     description:
-      "What `ganju deploy` sends: every trigger listed is saved as managed by the CLI, and the CLI's earlier ones not listed are deleted. Triggers made in the dashboard are left alone. All or nothing. New webhooks' secrets come back once, by name.",
+      "What `ganju deploy` sends: every trigger listed is saved as managed by the CLI, and the CLI's earlier ones not listed are deleted. Triggers made in the dashboard are left alone. All or nothing. New webhooks' secrets come back once, by name, and email addresses still to confirm as `confirming`.",
     body: DATA_TRIGGER_DEPLOY_BODY,
-    returns: '{ triggers, removed, secrets }'
+    returns: '{ triggers, removed, secrets, confirming? }'
   },
   listTriggerRuns: {
     method: 'get',