n8n-nodes-sendzen 1.0.0

package/shared/template/template.api.types.ts

@@ -0,0 +1,435 @@
+// shared/template/template.api.types.ts
+
+// Buttons
+export interface UrlButton {
+  type: 'URL';
+  text: string;
+  url: string;
+  example?: string[];
+}
+
+export interface PhoneNumberButton {
+  type: 'PHONE_NUMBER';
+  text: string;
+  phone_number: string;
+}
+
+export interface QuickReplyButton {
+  type: 'QUICK_REPLY';
+  text: string;
+}
+
+export interface CopyCodeButton {
+  type: 'COPY_CODE';
+  example: string;
+}
+
+export type TemplateButton = UrlButton | PhoneNumberButton | QuickReplyButton | CopyCodeButton;
+
+// Components
+export interface HeaderTextComponent {
+  type: 'HEADER';
+  format: 'TEXT';
+  text: string;
+  example?: {
+    header_text: string[];
+  }
+}
+
+export interface HeaderMediaComponent {
+  type: 'HEADER';
+  format: 'IMAGE' | 'VIDEO' | 'DOCUMENT';
+  example: {
+    header_handle: [string];
+  }
+}
+
+export interface HeaderLocationComponent {
+  type: 'HEADER';
+  format: 'LOCATION';
+}
+
+export interface HeaderProductComponent {
+  type: 'HEADER';
+  format: 'PRODUCT';
+}
+
+export type HeaderComponent = HeaderTextComponent | HeaderMediaComponent | HeaderLocationComponent | HeaderProductComponent;
+
+export interface BodyComponent {
+  type: 'BODY';
+  text: string;
+  example?: {
+    body_text?: string[][];
+    body_text_named_params?: {
+      param_name: string;
+      example: string;
+    }[];
+  };
+}
+
+export interface FooterComponent {
+  type: 'FOOTER';
+  text: string;
+}
+
+export interface ButtonsComponent {
+  type: 'BUTTONS';
+  buttons: TemplateButton[];
+}
+
+export interface LimitedTimeOfferComponent {
+  type: 'LIMITED_TIME_OFFER';
+  limited_time_offer: {
+    text: string;
+    has_expiration?: boolean;
+  };
+}
+
+// Media Carousel Template
+export type MediaCarouselButton = UrlButton | PhoneNumberButton | QuickReplyButton;
+
+export interface MediaCarouselCard {
+  components: (
+    | {
+      type: 'HEADER';
+      format: 'IMAGE' | 'VIDEO';
+      example: {
+        header_handle: [string];
+      };
+    }
+    | {
+      type: 'BUTTONS';
+      buttons: MediaCarouselButton[];
+    }
+  )[];
+}
+
+// Product Carousel Template
+export interface SPMButton {
+  type: 'SPM';
+  text: string;
+}
+
+export type ProductCarouselButton = SPMButton | UrlButton;
+
+export interface ProductCarouselCard {
+  components: (
+    | HeaderProductComponent
+    | {
+      type: 'BUTTONS';
+      buttons: ProductCarouselButton[];
+    }
+  )[];
+}
+
+// Generic Carousel Component
+export interface CarouselComponent {
+  type: 'CAROUSEL';
+  cards: (MediaCarouselCard | ProductCarouselCard)[];
+}
+
+export type TemplateComponent =
+  | HeaderComponent
+  | BodyComponent
+  | FooterComponent
+  | ButtonsComponent
+  | LimitedTimeOfferComponent
+  | CarouselComponent;
+
+// Main Template Interface
+export interface CustomMarketingTemplate {
+  name: string;
+  language: string;
+  category: 'MARKETING';
+  parameter_format?: string;
+  components: TemplateComponent[];
+}
+
+// Catalog Template
+export interface CatalogButton {
+  type: 'CATALOG';
+  text: string;
+}
+
+export type CatalogTemplateComponent = BodyComponent | FooterComponent | {
+  type: 'BUTTONS';
+  buttons: CatalogButton[];
+};
+
+export interface CatalogTemplate {
+  name: string;
+  language: string;
+  category: 'MARKETING';
+  components: CatalogTemplateComponent[];
+}
+
+// Authentication Template
+export interface AuthBodyComponent {
+  type: 'BODY';
+  add_security_recommendation?: boolean;
+}
+
+export interface AuthFooterComponent {
+  type: 'FOOTER';
+  code_expiration_minutes?: number;
+}
+
+export interface AuthOneTapButton {
+  type: 'OTP';
+  otp_type: 'one_tap';
+  text?: string; // copy_code_button_text
+  autofill_text?: string;
+  supported_apps: {
+    package_name: string;
+    signature_hash: string;
+  }[];
+}
+
+export interface AuthZeroTapButton {
+  type: 'OTP';
+  otp_type: 'zero_tap';
+  text?: string; // copy_code_button_text
+  autofill_text?: string;
+  zero_tap_terms_accepted: boolean;
+  supported_apps: {
+    package_name: string;
+    signature_hash: string;
+  }[];
+}
+
+export interface AuthCopyCodeButton {
+  type: 'OTP';
+  otp_type: 'copy_code';
+  text?: string;
+}
+
+export type AuthOtpButton = AuthOneTapButton | AuthZeroTapButton | AuthCopyCodeButton;
+
+export interface AuthButtonsComponent {
+  type: 'BUTTONS';
+  buttons: AuthOtpButton[];
+}
+
+export type AuthTemplateComponent = AuthBodyComponent | AuthFooterComponent | AuthButtonsComponent;
+
+export interface AuthenticationTemplate {
+  name: string;
+  language: string;
+  category: 'AUTHENTICATION';
+  message_send_ttl_seconds?: number;
+  components: AuthTemplateComponent[];
+}
+
+// Call Permission Request Template
+export interface CallPermissionRequestComponent {
+  type: 'CALL_PERMISSION_REQUEST';
+}
+
+export type CallPermissionRequestTemplateComponent = BodyComponent | CallPermissionRequestComponent;
+
+export interface CallPermissionRequestTemplate {
+  name: string;
+  language: string;
+  category: 'MARKETING' | 'UTILITY';
+  components: CallPermissionRequestTemplateComponent[];
+}
+
+// MPM Template
+export interface MPMButton {
+  type: 'MPM';
+  text: string;
+}
+
+export type MPMTemplateComponent = HeaderTextComponent | BodyComponent | FooterComponent | {
+  type: 'BUTTONS';
+  buttons: MPMButton[];
+};
+
+export interface MPMTemplate {
+  name: string;
+  language: string;
+  category: 'MARKETING';
+  components: MPMTemplateComponent[];
+}
+
+export type SPMTemplateComponent = HeaderProductComponent | BodyComponent | FooterComponent | {
+  type: 'BUTTONS';
+  buttons: SPMButton[];
+};
+
+// SPM Template
+export interface SPMTemplate {
+  name: string;
+  language: string;
+  category: 'MARKETING';
+  components: SPMTemplateComponent[];
+}
+
+// Utility Template
+export interface UtilityTemplate {
+  name: string;
+  language: string;
+  category: 'UTILITY';
+  parameter_format?: string;
+  components: TemplateComponent[];
+}
+
+export type CreateTemplatePayload =
+  | CustomMarketingTemplate
+  | CatalogTemplate
+  | AuthenticationTemplate
+  | CallPermissionRequestTemplate
+  | MPMTemplate
+  | SPMTemplate
+  | UtilityTemplate;
+
+export interface CreateTemplateResponse {
+  id: string;
+  status: string;
+  category: string;
+}
+
+// --- GET All Templates Response Types ---
+export interface Paging {
+  cursors: {
+    before: string;
+    after: string;
+  };
+  next?: string;
+}
+
+export interface ResponseUrlButton {
+  type: 'URL';
+  text: string;
+  url: string;
+}
+
+export interface ResponsePhoneNumberButton {
+  type: 'PHONE_NUMBER';
+  text: string;
+  phone_number: string;
+}
+
+export interface ResponseQuickReplyButton {
+  type: 'QUICK_REPLY';
+  text: string;
+}
+
+export interface ResponseFlowButton {
+  type: 'FLOW';
+  text: string;
+  flow_id: number;
+  flow_action: string;
+  navigate_screen: string;
+}
+
+export interface ResponseSPMButton {
+  type: 'SPM';
+  text: string;
+}
+
+export type ResponseButton = ResponseUrlButton | ResponsePhoneNumberButton | ResponseQuickReplyButton | ResponseFlowButton | ResponseSPMButton;
+
+export interface ResponseHeaderTextComponent {
+  type: 'HEADER';
+  format: 'TEXT';
+  text: string;
+  example?: {
+    header_text: string[];
+  };
+}
+
+export interface ResponseHeaderMediaComponent {
+  type: 'HEADER';
+  format: 'IMAGE' | 'VIDEO' | 'DOCUMENT';
+  example: {
+    header_handle: string[];
+  };
+}
+
+export interface ResponseHeaderLocationComponent {
+  type: 'HEADER';
+  format: 'LOCATION';
+}
+
+export interface ResponseHeaderProductComponent {
+  type: 'HEADER';
+  format: 'PRODUCT';
+}
+
+export type ResponseHeaderComponent =
+  | ResponseHeaderTextComponent
+  | ResponseHeaderMediaComponent
+  | ResponseHeaderLocationComponent
+  | ResponseHeaderProductComponent;
+
+export interface ResponseBodyComponent {
+  type: 'BODY';
+  text: string;
+  add_security_recommendation?: boolean;
+  example?: {
+    body_text?: string[][];
+    body_text_named_params?: {
+      param_name: string;
+      example: string;
+    }[];
+  };
+}
+
+export interface ResponseFooterComponent {
+  type: 'FOOTER';
+  text: string;
+  code_expiration_minutes?: number;
+}
+
+export interface ResponseButtonsComponent {
+  type: 'BUTTONS';
+  buttons: ResponseButton[];
+}
+
+export interface ResponseCarouselCard {
+  components: (ResponseHeaderComponent | ResponseButtonsComponent)[];
+}
+
+export interface ResponseCarouselComponent {
+  type: 'CAROUSEL';
+  cards: ResponseCarouselCard[];
+}
+
+export type ResponseComponent =
+  | ResponseHeaderComponent
+  | ResponseBodyComponent
+  | ResponseFooterComponent
+  | ResponseButtonsComponent
+  | ResponseCarouselComponent;
+
+export interface MessageTemplate {
+  id: string;
+  name: string;
+  components?: ResponseComponent[];
+  language: string;
+  status: "APPROVED" | "PENDING" | "REJECTED";
+  category: "UTILITY" | "MARKETING" | "AUTHENTICATION";
+  message_send_ttl_seconds?: number;
+  parameter_format?: "named" | "positional";
+  sub_category?: string;
+}
+
+export interface GetAllTemplatesResponse {
+  data: MessageTemplate[];
+  paging?: Paging;
+}
+
+
+export interface TemplatesResponse {
+	data?: { data: MessageTemplate[] };
+	paging?: {
+		cursors: {
+			before: string;
+			after: string;
+		};
+		next?: string;
+	};
+	message?: string;
+}

package/shared/template/template.builder.ts

@@ -0,0 +1,223 @@
+import { MessageTemplate, ResponseBodyComponent, ResponseHeaderComponent, ResponseButtonsComponent, ResponseCarouselComponent } from './template.api.types';
+
+export interface TemplatePayloadParams {
+	from: string;
+	to: string;
+	template: MessageTemplate;
+	variables: Record<string, string>;
+}
+
+/**
+ * Builds the SendZen/WhatsApp template payload based on the selected template structure
+ * and the variables provided by the user in the n8n Resource Mapper.
+ */
+export function buildTemplatePayload(params: TemplatePayloadParams) {
+	const { template, variables, from, to } = params;
+	const templateComponents: any[] = [];
+
+	if (!template.components) {
+		return {
+			from,
+			to,
+			type: 'template',
+			template: {
+				name: template.name,
+				lang_code: template.language,
+				components: [],
+			},
+		};
+	}
+
+	const processComponent = (component: any, prefix = '') => {
+		switch (component.type) {
+			case 'HEADER': {
+				const header = component as ResponseHeaderComponent;
+				if (header.format === 'TEXT' && header.text) {
+					const tokens = header.text.match(/\{\{([^}]+)\}\}/g);
+					if (tokens && tokens.length > 0) {
+						const parameters = tokens.map((match) => {
+							const inner = match.replace(/[{}]/g, '');
+							const isNumber = /^\d+$/.test(inner);
+							const fieldId = `header_param_${inner}`;
+							const value = variables[fieldId] || match;
+
+							return {
+								type: 'text',
+								text: value,
+								...(isNumber ? {} : { parameter_name: inner }),
+							};
+						});
+
+						templateComponents.push({
+							type: 'header',
+							parameters: parameters,
+						});
+					}
+				} else if (header.format && ['IMAGE', 'VIDEO', 'DOCUMENT'].includes(header.format)) {
+					const mediaType = header.format.toLowerCase();
+					const mediaUrl = variables['header_media_url'] || '';
+
+					if (mediaUrl) {
+						templateComponents.push({
+							type: 'header',
+							parameters: [
+								{
+									type: mediaType,
+									[mediaType]: {
+										link: mediaUrl,
+									},
+								},
+							],
+						});
+					}
+				}
+				break;
+			}
+
+			case 'BODY': {
+				const body = component as ResponseBodyComponent;
+				if (body.text) {
+					const tokens = body.text.match(/\{\{([^}]+)\}\}/g);
+					if (tokens && tokens.length > 0) {
+						const parameters = tokens.map((match) => {
+							const inner = match.replace(/[{}]/g, '');
+							const isNumber = /^\d+$/.test(inner);
+							const fieldId = `body_param_${inner}`;
+							const value = variables[fieldId] || match;
+
+							return {
+								type: 'text',
+								text: value,
+								...(isNumber ? {} : { parameter_name: inner }),
+							};
+						});
+
+						templateComponents.push({
+							type: 'body',
+							parameters: parameters,
+						});
+					}
+				}
+				break;
+			}
+
+			case 'BUTTONS': {
+				const buttonsComp = component as ResponseButtonsComponent;
+				if (buttonsComp.buttons && buttonsComp.buttons.length > 0) {
+					buttonsComp.buttons.forEach((button, buttonIndex) => {
+						if (button.type === 'URL' && button.url) {
+							const urlToken = button.url.match(/\{\{([^}]+)\}\}/);
+							if (urlToken && urlToken[1]) {
+								const inner = urlToken[1];
+								const isNumber = /^\d+$/.test(inner);
+								const fieldId = `button_${buttonIndex}_param_${inner}`;
+								const value = variables[fieldId] || '123456';
+
+								templateComponents.push({
+									type: 'button',
+									sub_type: 'url',
+									index: buttonIndex,
+									parameters: [
+										{
+											type: 'text',
+											text: value,
+											...(isNumber ? {} : { parameter_name: inner }),
+										},
+									],
+								});
+							}
+						} else if ((button.type as any) === 'COPY_CODE') {
+							const searchableText = (button as any).text || (button as any).url || '';
+							const codeToken = searchableText.match(/\{\{([^}]+)\}\}/);
+							if (codeToken && codeToken[1]) {
+								const inner = codeToken[1];
+								const isNumber = /^\d+$/.test(inner);
+								const fieldId = `button_${buttonIndex}_param_${inner}`;
+								const value = variables[fieldId] || '123456';
+
+								templateComponents.push({
+									type: 'button',
+									sub_type: 'copy_code',
+									index: buttonIndex,
+									parameters: [
+										{
+											type: 'text',
+											text: value,
+											...(isNumber ? {} : { parameter_name: inner }),
+										},
+									],
+								});
+							}
+						} else if (button.type === 'FLOW') {
+							const flowButton = button as any;
+							const flowAction: {
+								flow_token?: string;
+								flow_action_data?: any;
+							} = {};
+
+							const flowToken = variables[`button_${buttonIndex}_flow_token`];
+							flowAction.flow_token = flowToken || 'unused';
+
+							const customFlowActionData = variables[`button_${buttonIndex}_flow_action_data`];
+							if (customFlowActionData) {
+								try {
+									flowAction.flow_action_data =
+										typeof customFlowActionData === 'string'
+											? JSON.parse(customFlowActionData)
+											: customFlowActionData;
+								} catch (e) {
+									flowAction.flow_action_data = {};
+								}
+							} else if (flowButton.flow_id || flowButton.flow_action || flowButton.navigate_screen) {
+								flowAction.flow_action_data = {};
+								if (flowButton.flow_id) flowAction.flow_action_data.flow_id = flowButton.flow_id;
+								if (flowButton.flow_action)
+									flowAction.flow_action_data.flow_action = flowButton.flow_action;
+								if (flowButton.navigate_screen)
+									flowAction.flow_action_data.navigate_screen = flowButton.navigate_screen;
+							}
+
+							templateComponents.push({
+								type: 'button',
+								sub_type: 'flow',
+								index: buttonIndex,
+								parameters: [
+									{
+										type: 'action',
+										action: flowAction,
+									},
+								],
+							});
+						}
+					});
+				}
+				break;
+			}
+
+			case 'CAROUSEL': {
+				const carousel = component as ResponseCarouselComponent;
+				if (carousel.cards) {
+					carousel.cards.forEach((card, i) => {
+						card.components.forEach((cardComp) => {
+							processComponent(cardComp, `card_${i + 1}_`);
+						});
+					});
+				}
+				break;
+			}
+		}
+	};
+
+	template.components.forEach((comp) => processComponent(comp));
+
+	return {
+		from,
+		to,
+		type: 'template',
+		template: {
+			name: template.name,
+			lang_code: template.language,
+			components: templateComponents,
+		},
+	};
+}

package/shared/type.ts

@@ -0,0 +1,40 @@
+export interface WABAResponseList {
+	message: string;
+	data: {
+		projects: {
+			id: number;
+			project_name: string;
+			client_identifier: string;
+			wabas: {
+				id: number;
+				waba_id: string;
+				waba_business_name: string;
+				phone_number_id: string;
+				phone_number: string;
+				number_status: string;
+				setup_mode: string;
+				mm_lite_api_status: string;
+				phone_number_type: string;
+				waba_onboard_stage: string;
+			}[];
+		}[];
+	};
+}
+
+export interface SendTextMessageRequest {
+	from: string;
+	to: string;
+	type: 'text';
+	text: {
+		body: string;
+		preview_url?: boolean;
+	};
+}
+
+export type SendzenAPIErroResponse = {
+	message: string;
+	error: {
+		code: string;
+		details: string;
+	};
+};

package/shared/utils.ts

@@ -0,0 +1,16 @@
+import { SendzenAPIErroResponse } from "./type";
+
+export function isSendzenAPIErroResponse(
+    value: unknown
+  ): value is SendzenAPIErroResponse {
+    return (
+      typeof value === 'object' &&
+      value !== null &&
+      'message' in value &&
+      typeof (value as any).message === 'string' &&
+      'error' in value &&
+      typeof (value as any).error === 'object' &&
+      typeof (value as any).error?.code === 'string' &&
+      typeof (value as any).error?.details === 'string'
+    );
+  }