@apostlejs/whatsapp 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Fernando Coelho]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("zod");function t(e){return e&&e.__esModule?e:{default:e}}var a=t(require("node:crypto")),r=Object.defineProperty,n=(e,t)=>{for(var a in t)r(e,a,{get:t[a],enumerable:!0})},o={create:{url:"/{waba_id}/flows",method:"post",headers:{"Content-Type":"application/json"},request:{body:null},response:null},updateMetadata:{url:"/{flow_id}",method:"post",headers:{"Content-Type":"application/json"},request:{body:null},response:null},readMany:{url:"/{waba_id}/flows",method:"get",response:null},delete:{url:"/{flow_id}",method:"delete",response:null},read:{url:"/{flow_id}",method:"get",request:{query:null},response:null},updateJson:{url:"/{flow_id}/assets",method:"post",request:{body:null},response:null},getPreview:{url:"/{flow_id}?fields=preview.invalidate(false)",method:"get",response:null},publish:{url:"/{flow_id}/publish",method:"post",response:null}},s={send:{url:"/{number_id}/messages",method:"post",headers:{"Content-Type":"application/json"},request:{body:null},response:null}},i={updateEncryption:{url:"/{number_id}/whatsapp_business_encryption",method:"post",headers:{"Content-Type":"application/x-www-form-urlencoded"},request:{body:null}},registerNumber:{url:"/{number_id}/register",method:"post",headers:{"Content-Type":"application/json"},request:{body:null}}},c={flows:o,messages:s,waba:i},l=e.z.enum(["INIT","BACK","data_exchange","navigate","ping"]),p=e.z.enum(["SIGN_UP","SIGN_IN","APPOINTMENT_BOOKING","LEAD_GENERATION","CONTACT_US","CUSTOMER_SUPPORT","SURVEY","OTHER"]),u=e.z.object({media_id:e.z.string(),cdn_url:e.z.string(),file_name:e.z.string(),encryption_metadata:e.z.object({encrypted_hash:e.z.string(),iv:e.z.string(),encryption_key:e.z.string(),hmac_key:e.z.string(),plaintext_hash:e.z.string()})}),d=e.z.object({name:e.z.string(),categories:e.z.array(p),application_id:e.z.string().optional(),endpoint_uri:e.z.string().optional()}),f=e.z.union([e.z.literal("SUCCESS"),e.z.string()]),m=e.z.enum(["DRAFT","PUBLISHED","DEPRECATED","BLOCKED","THROTTLED"]),y=e.z.enum(["AVAILABLE","LIMITED","BLOCKED"]),_=e.z.object({error:e.z.string(),error_type:e.z.string(),message:e.z.string(),line_start:e.z.number(),line_end:e.z.number(),column_start:e.z.number(),column_end:e.z.number()}),h={},w={setup:e=>{Object.assign(h,e)},get:e=>{const t=h[e]??process.env[e];if(!t)throw new Error(`Missing environment variable: ${e}`);return t}},g={};n(g,{actions:()=>H,flows:()=>U,parsers:()=>q,security:()=>K,utils:()=>j});var b={};async function v(e,t,a){const r=`https://graph.facebook.com/v${w.get("GRAPH_API_VERSION")}`,n={Authorization:`Bearer ${w.get("META_APP_ACCESS_TOKEN")}`};let o=e.url;const s={...n,...e.headers,...t.headers},i=new URLSearchParams(t.query).toString();"/"===o[0]&&(o=o.slice(1)),o=`${r}/${o}`,i&&(o=`${o}?${i}`);const c={waba_id:w.get("WHATSAPP_ACCOUNT_ID"),number_id:w.get("WHATSAPP_NUMBER_ID"),...t.params};for(const e in c)o=o.replace(`{${e}}`,c[e]);const l=t.body;let p;if(l&&a?.asFormData){const e=new FormData;for(const t in l)e.append(t,l[t]);p=e}else l&&a?.asUrlEncoded?p=new URLSearchParams(l).toString():l&&(p=JSON.stringify(l));return await fetch(o,{method:e.method,headers:s,body:p}).then((e=>e.json())).then((e=>{if("error"in e)throw{response:{data:e.error}};return e})).catch((async e=>{throw e.response.data}))}async function E(e){return v(c.flows.create,{body:e})}async function S(e,t){const a=c.flows.updateMetadata;return await v(a,{body:t,params:{flow_id:e}})}async function A(e,t){return v(c.flows.updateJson,{params:{flow_id:e},body:{name:"flow.json",asset_type:"FLOW_JSON",file:new Blob([JSON.stringify(t,null,2)],{type:"application/json"})}},{asFormData:!0})}async function I(e,t){const a=c.flows.getPreview,{preview:r}=await v(a,{params:{flow_id:e}}),n=r.preview_url.replaceAll("\\",""),o=Object.entries(t??{}).reduce(((e,[t,a])=>(e[t]="flow_action_payload"===t?encodeURIComponent(JSON.stringify(a)):a.toString(),e)),{});return`${n}&${new URLSearchParams(o).toString()}`}async function P(e){return v(c.flows.delete,{params:{flow_id:e}})}async function N(e,t){return v(c.flows.read,{params:{flow_id:e},query:{fields:t?.fields.join(",")??""}})}async function T(){return v(c.flows.readMany,{})}async function x(e){return v(c.flows.publish,{params:{flow_id:e}})}n(b,{create:()=>E,delete:()=>P,get:()=>N,getMany:()=>T,getPreview:()=>I,publish:()=>x,updateJson:()=>A,updateMetadata:()=>S});var C={};async function O(e){const t=w.get("WHATSAPP_UNNOFICIAL_AUTHENTICATION_STRING"),a=await async function(e){const t=w.get("WHATSAPP_UNNOFICIAL_AUTHENTICATION_STRING");return await fetch("https://business.facebook.com/latest/whatsapp_manager/flows?flow_id="+e,{headers:{accept:"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8","accept-language":"en-US,en;q=0.5","cache-control":"no-cache",pragma:"no-cache",priority:"u=0, i","sec-ch-ua":'"Brave";v="131", "Chromium";v="131", "Not_A Brand";v="24"',"sec-ch-ua-full-version-list":'"Brave";v="131.0.0.0", "Chromium";v="131.0.0.0", "Not_A Brand";v="24.0.0.0"',"sec-ch-ua-mobile":"?0","sec-ch-ua-model":'""',"sec-ch-ua-platform":'"Linux"',"sec-ch-ua-platform-version":'"6.11.9"',"sec-fetch-dest":"document","sec-fetch-mode":"navigate","sec-fetch-site":"same-origin","sec-fetch-user":"?1","sec-gpc":"1","upgrade-insecure-requests":"1",cookie:t},referrerPolicy:"strict-origin-when-cross-origin",body:null,method:"GET"}).then((e=>e.text())).then((e=>{const t=/<script\b[^>]*\bid=["']__eqmc["'][^>]*>(.*?)<\/script>/is.exec(e);if(!t)throw new Error("No matching <script> tag found.");const{f:a}=JSON.parse(t[1]);return a}))}(e),r={__aaid:"0",__bid:"250887754468924",__user:"100072333227027",__a:"1",__req:"m",dpr:"1",__ccg:"EXCELLENT",__rev:"1019090278",__comet_req:"11",fb_dtsg:a,__spin_b:"trunk",__jssesw:"1",fb_api_caller_class:"RelayModern",fb_api_req_friendly_name:"WAMFlowsBuilderDynamicSetupHealthCheckQuery",variables:JSON.stringify({flowID:e}),server_timestamps:"true",doc_id:" 7983200618385332"},n=new URLSearchParams(r).toString();return await fetch("https://business.facebook.com/api/graphql",{headers:{accept:"*/*","accept-language":"en-US,en;q=0.5","cache-control":"no-cache","content-type":"application/x-www-form-urlencoded",pragma:"no-cache",priority:"u=1, i","sec-ch-ua":'"Brave";v="131", "Chromium";v="131", "Not_A Brand";v="24"',"sec-ch-ua-full-version-list":'"Brave";v="131.0.0.0", "Chromium";v="131.0.0.0", "Not_A Brand";v="24.0.0.0"',"sec-ch-ua-mobile":"?0","sec-ch-ua-model":'""',"sec-ch-ua-platform":'"Linux"',"sec-ch-ua-platform-version":'"6.11.9"',"sec-fetch-dest":"empty","sec-fetch-mode":"cors","sec-fetch-site":"same-origin","sec-gpc":"1","x-fb-friendly-name":"WAMFlowsBuilderDynamicSetupHealthCheckQuery",cookie:t,Referer:"https://business.facebook.com/latest/whatsapp_manager/flows?flow_id=1137578314629992","Referrer-Policy":"strict-origin-when-cross-origin"},body:n,method:"POST"}).then((e=>e.text())).then((e=>e)).catch((e=>{console.error(e)}))}n(C,{verifyFlowIntegrity:()=>O});var B=e=>e.split("?")[0],U={createToken:({flow_name:e,flow_parameters:t,chatId:a})=>{const r=new URLSearchParams({chat_id:a});if(r.set("flow_identifier",crypto.randomUUID()),t)for(const[e,a]of Object.entries(t))r.set(e,a.toString());return`${e}?${decodeURIComponent(r.toString())}`},getName:B,destructureFlowToken:e=>{const t=B(e);let a=e.split("?")?.[1];"&"===a?.[0]&&(a=a.slice(1));const r=new URLSearchParams(a),n=r.get("chat_id")||r.get("chatId"),o=r.get("flow_identifier")||r.get("flowIdentifier"),s={};for(const[e,t]of r.entries())"chat_id"!==e&&"chatId"!==e&&"flow_identifier"!==e&&"flowIdentifier"!==e&&(s[e]=t);return{paramsString:a,flowName:t,chatId:n,flowIdentifier:o,flowParameters:s}}},R=e=>{const t={to:e.to,messaging_product:"whatsapp",recipient_type:"individual"};return e.reply&&(t.context=e.reply),e.showUrlPreviewImage&&(t.preview_url=e.showUrlPreviewImage),t},k={flow:e=>{if("flow"!==e.message.type)throw new Error("Invalid type");const{message:t,...a}=e,{flow:r,...n}=t,o=R(a);r.mode||(r.mode=w.get("WHATSAPP_FLOWS_MODE"));const s=U.createToken({chatId:o.to,flow_name:r.name,flow_parameters:r.parameters});return{type:"interactive",...o,interactive:{...n,type:"flow",action:{name:"flow",parameters:{flow_name:r.name,flow_token:s,flow_message_version:"3",flow_cta:r.buttonText,flow_action:r.action??"navigate",mode:r.mode,...r.payload&&{flow_action_payload:{...r.payload,screen:r.payload.screen.toUpperCase()}}}}}}},text:e=>{if("text"!==e.message.type)throw new Error("Invalid type");const{message:t,...a}=e,r=R(a),n={type:"text",text:{body:t.text},...r};return e.message.previewUrl&&n.text&&(n.text.preview_url=e.message.previewUrl),n},list:e=>{if("list"!==e.message.type)throw new Error("Invalid type");const{message:t,...a}=e,{list:r,type:n,...o}=t;return{...R(a),type:"interactive",interactive:{...o,type:n,action:{button:r.buttonText,sections:r.sections}}}},button:e=>{if("button"!==e.message.type)throw new Error("Invalid type");const{message:t,...a}=e,{buttons:r,type:n,...o}=t;return{...R(a),type:"interactive",interactive:{...o,type:n,action:{buttons:r.map((e=>({id:e.id,title:e.text,type:"reply"})))}}}},template:e=>{if("template"!==e.message.type)throw new Error("Invalid type");const{message:{type:t,...a},...r}=e,n={...R(r),type:t,template:{...a,language:{code:a.language}}};return n.template&&(n.template.namespace=process.env.WHATSAPP_MESSAGE_NAMESPACE),n},media:e=>{if("media"!==e.message.type)throw new Error("Invalid type");const{message:{type:t,...a},...r}=e,n=Object.entries(a)[0],[o,{ref:s,...i}]=n,c=i,l=R(r);return Number.isNaN(Number(s))?c.link=s:c.id=s,{type:o,[o]:c,...l}}};function z(e){const{encrypted_aes_key:t,encrypted_flow_data:r,initial_vector:n}=e,o=a.default.createPrivateKey({key:w.get("WHATSAPP_ACCOUNT_ENCRYPTION_PRIVATE_KEY"),passphrase:w.get("WHATSAPP_ACCOUNT_ENCRYPTION_PASSPHRASE")}),s=a.default.privateDecrypt({key:o,padding:a.default.constants.RSA_PKCS1_OAEP_PADDING,oaepHash:"sha256"},Buffer.from(t,"base64")),i=Buffer.from(r,"base64"),c=Buffer.from(n,"base64"),l=i.subarray(0,-16),p=i.subarray(-16),u=a.default.createDecipheriv("aes-128-gcm",s,c);u.setAuthTag(p);const d=Buffer.concat([u.update(l),u.final()]).toString("utf-8");return{payload:JSON.parse(d),encryptionMetadata:{aesKeyBuffer:s,initialVectorBuffer:c}}}function M(e){const t=new URL(e.url).searchParams,a=t.get("hub.verify_token"),r=t.get("hub.challenge");return!(!a||!r)&&a===w.get("WHATSAPP_WEBHOOK_KEY")&&r}async function D(e,t){const r=e.headers.get("x-hub-signature-256");if(!r)return!1;const n=r.replace("sha256=",""),o=a.default.createHmac("sha256",w.get("WHATSAPP_WEBHOOK_KEY")).update(t,"utf-8").digest("hex");return!!a.default.timingSafeEqual(Buffer.from(n),Buffer.from(o))}var q={toGraph:{sendMessage:e=>k[e.message.type](e),flowResponse:(e,t)=>{if(!t.data)throw new Error("Missing data in flow response");if(!t.screen)throw new Error("Missing screen in flow response");if(t.screen=t.screen.toUpperCase(),"SUCCESS"===t.screen){const a=t.data??{};t.data={extension_message_response:{params:{flow_token:e,...a}}}}return t}},toSDK:{webhook:async function(e){if("GET"===e.method){const t=M(e);if(!t)throw new Error("Invalid request");return{type:"healthCheck",payload:t}}const t=await e.text(),a=JSON.parse(t);if("entry"in a){if(!D(e,t))throw new Error("Invalid request");const n=a.entry.flatMap((e=>e.changes)).filter((e=>"messages"===e.field)).flatMap((e=>e.value.messages)).filter(Boolean).map((e=>function(e){const t=e.from,a={id:e.id,type:e.type,timestamp:e.timestamp,metadata:{forwarded:e.context?.forwarded,frequentlyForwarded:e.context?.frequently_forwarded}},r=function(e){if(!(e.audio||e.document||e.video||e.image))return null;const t=e.audio?.id??e.document?.id??e.image?.id??e.video?.id,a=e.audio?.mime_type??e.document?.mime_type??e.image?.mime_type??e.video?.mime_type,r=["audio","document","image","video"].find((t=>e[t])),n=e.image?.sha256??e.document?.sha256??e.video?.sha256;return{id:t,type:r,caption:e.document?.caption??e.image?.caption??e.video?.caption??null,mime_type:a,sha256:n,filename:e.document?.filename??e.video?.filename}}(e),n=function(e){return e.text?.body??e.button?.text??e.interactive?.button_reply?.title??e.interactive?.list_reply?.title??e.document?.caption??null}(e),o=function(e){return e.interactive?{...e.interactive?.button_reply||e.button?{button:{id:e.interactive?.button_reply?.id??null,title:e.button?.text??e.interactive.button_reply?.title,payload:e.button?.payload??null}}:{},...e.interactive.list_reply?{selectedOption:{id:e.interactive.list_reply.id,title:e.interactive.list_reply.title,description:e.interactive.list_reply.description}}:{},...e.interactive.nfm_reply?{flowResponse:JSON.parse(e.interactive.nfm_reply.response_json)}:{}}:null}(e);return{...a,...o&&{interaction:o},...r&&{media:r},text:n,chatId:t}}(e)));return{type:"application",payload:{messageReceived:(r=n,r.length?r:void 0)}}}var r;if("encrypted_flow_data"in a)return{type:"flowExchange",payload:{...z(a),pingResponse:{data:{status:"active"}}}};throw new Error("Invalid request")}}},H={messages:{send:async function(e){const t=q.toGraph.sendMessage(e),a=c.messages.send;return await v(a,{body:t})}},flows:{...b,unnoficial:C},waba:{registerNumber:async function({dataRegion:e,pin:t}){const a=c.waba.registerNumber,r={messaging_product:"whatsapp",pin:t};return e&&(r.data_localization_region=e),await v(a,{body:r},{asUrlEncoded:!0})},encryption:{upload:async function(e){const t=c.waba.updateEncryption,a={business_public_key:e};return await v(t,{body:a},{asUrlEncoded:!0})}}}};async function L(e){return await fetch(e).then((async e=>{const t=await e.arrayBuffer();return Buffer.from(t)}))}var K={verifyHub:M,verifySignature:D,generateWabaEncryption:async function(){const e=a.default.randomUUID(),{publicKey:t,privateKey:r}=a.default.generateKeyPairSync("rsa",{modulusLength:2048,publicKeyEncoding:{type:"spki",format:"pem"},privateKeyEncoding:{type:"pkcs8",format:"pem",cipher:"aes-256-cbc",passphrase:e}});return{passphrase:e,publicKey:t,privateKey:r}},decryptFlowBody:z,encryptFlowResponse:function(e,t){const r=[];for(const e of Buffer.from(t.initialVectorBuffer).entries())r.push(~e[1]);const n=a.default.createCipheriv("aes-128-gcm",Buffer.from(t.aesKeyBuffer),Buffer.from(r));return Buffer.concat([n.update(JSON.stringify(e),"utf-8"),n.final(),n.getAuthTag()]).toString("base64")},decryptFlowMedia:async function(e){const t=[];for(const r of e){let{cdn_url:e,encryption_metadata:n}=r;if("EXAMPLE_DATA__CDN_URL_WILL_COME_IN_THIS_FIELD"===e){e="https://picsum.photos/seed/picsum/200";const a=await L(e);t.push(a);continue}const o=await L(e),{iv:s,encryption_key:i,hmac_key:c,encrypted_hash:l,plaintext_hash:p}=n,u={iv:Buffer.from(s,"base64"),encryption_key:Buffer.from(i,"base64"),hmac_key:Buffer.from(c,"base64")};if(a.default.createHash("sha256").update(o).digest("base64")!==l)throw new Error("Encrypted hash validation failed");const d=o.subarray(0,o.length-10),f=o.subarray(-10);if(!a.default.createHmac("sha256",u.hmac_key).update(Buffer.concat([u.iv,d])).digest().subarray(0,10).equals(f))throw new Error("HMAC validation failed");const m=a.default.createDecipheriv("aes-256-cbc",u.encryption_key,u.iv),y=m.update(d),_=Buffer.concat([y,m.final()]);if(a.default.createHash("sha256").update(_).digest("base64")!==p)throw new Error("Decrypted media hash validation failed");t.push(_)}return t}},j={flows:U},W={graph:{endpoints:c},settings:w,sdk:g};exports.actions=H,exports.endpoints=c,exports.flowAction=l,exports.flowCanSendMessageStatus=y,exports.flowCategory=p,exports.flowMediaData=u,exports.flowMetadata=d,exports.flowScreen=f,exports.flowStatus=m,exports.flowValidationError=_,exports.flows=U,exports.flowsEndpoints=o,exports.messagesEndpoints=s,exports.parsers=q,exports.security=K,exports.utils=j,exports.wabaEndpoints=i,exports.whatsapp=W;

package/dist/index.d.cts

@@ -0,0 +1,1185 @@
+import { z } from 'zod';
+
+type WhatsappSDKSettings = {
+    GRAPH_API_VERSION: string;
+    META_APP_ACCESS_TOKEN: string;
+    META_APP_ID: string;
+    META_APP_SECRET: string;
+    WHATSAPP_MESSAGE_NAMESPACE: string;
+    WHATSAPP_WEBHOOK_KEY: string;
+    WHATSAPP_NUMBER_ID: string;
+    WHATSAPP_ACCOUNT_ID: string;
+    WHATSAPP_ACCOUNT_ENCRYPTION_PUBLIC_KEY: string;
+    WHATSAPP_ACCOUNT_ENCRYPTION_PRIVATE_KEY: string;
+    WHATSAPP_ACCOUNT_ENCRYPTION_PASSPHRASE: string;
+    WHATSAPP_FLOWS_MODE: string;
+    WHATSAPP_UNNOFICIAL_AUTHENTICATION_STRING: string;
+};
+
+type AnyType = any;
+type Defined<T> = Exclude<T, undefined>;
+
+type HttpMethod = "get" | "post" | "put" | "delete" | "patch";
+type RequestData = Record<string, AnyType>;
+type IRequest = {
+    body?: RequestData;
+    query?: RequestData;
+    headers?: RequestData;
+};
+type IResponse = AnyType;
+type Endpoint<Url extends string, Method extends HttpMethod, Req extends IRequest, Res extends IResponse = AnyType> = {
+    url: Url;
+    method: Method;
+    headers?: RequestData;
+    request?: Req;
+    response?: Res;
+};
+
+declare const endpoints: {
+    flows: {
+        create: Endpoint<"/{waba_id}/flows", "post", {
+            body: WhatsappCreateFlowRequestBody;
+        }, WhatsappCreateFlowResponse>;
+        updateMetadata: Endpoint<"/{flow_id}", "post", {
+            body: WhatsappFlowUpdateMetadataRequestBody;
+        }, WhatsappFlowUpdateMetadataResponse>;
+        readMany: Endpoint<"/{waba_id}/flows", "get", IRequest, WhatsappGetManyFlowsRequestResponse>;
+        delete: Endpoint<"/{flow_id}", "delete", IRequest, WhatsappDeleteFlowResponse>;
+        read: Endpoint<"/{flow_id}", "get", {
+            query: WhatsappGetFlowsRequestQuery;
+        }, WhatsappGetManyFlowsRequestResponse>;
+        updateJson: Endpoint<"/{flow_id}/assets", "post", {
+            body: WhatsappUpdateFlowJsonRequestBody;
+        }, WhatsappUpdateFlowJsonResponse>;
+        getPreview: Endpoint<"/{flow_id}?fields=preview.invalidate(false)", "get", IRequest, WhatsappGetFlowWebPreviewURLResponse>;
+        publish: Endpoint<"/{flow_id}/publish", "post", IRequest, WhatsappPublishFlowResponse>;
+    };
+    messages: {
+        send: Endpoint<"/{number_id}/messages", "post", {
+            body: WhatsappSendMessageRequestBody<any>;
+        }, WhatsappSendMessageResponse>;
+    };
+    waba: {
+        updateEncryption: Endpoint<"/{number_id}/whatsapp_business_encryption", "post", {
+            body: WhatsappWabaUploadEncryptionRequestBody;
+        }, unknown>;
+        registerNumber: Endpoint<"/{number_id}/register", "post", {
+            body: WhatsappRegisterPhoneNumberRequestBody;
+        }, unknown>;
+    };
+};
+
+declare const flowCategory: z.ZodEnum<["SIGN_UP", "SIGN_IN", "APPOINTMENT_BOOKING", "LEAD_GENERATION", "CONTACT_US", "CUSTOMER_SUPPORT", "SURVEY", "OTHER"]>;
+type FlowCategory = z.infer<typeof flowCategory>;
+
+type WhatsappCreateFlowRequestBody = {
+    name: string;
+    categories: FlowCategory[];
+    clone_flow_id?: string;
+    endpoint_uri?: string;
+    flow_json?: string;
+    publish?: boolean;
+};
+type WhatsappCreateFlowResponse = {
+    id: string;
+};
+
+type WhatsappDeleteFlowResponse = {
+    success: boolean;
+};
+
+declare const flowStatus: z.ZodEnum<["DRAFT", "PUBLISHED", "DEPRECATED", "BLOCKED", "THROTTLED"]>;
+type FlowStatus = z.infer<typeof flowStatus>;
+declare const flowCanSendMessageStatus: z.ZodEnum<["AVAILABLE", "LIMITED", "BLOCKED"]>;
+type FlowCanSendMessageStatus = z.infer<typeof flowCanSendMessageStatus>;
+
+declare const flowValidationError: z.ZodObject<{
+    error: z.ZodString;
+    error_type: z.ZodString;
+    message: z.ZodString;
+    line_start: z.ZodNumber;
+    line_end: z.ZodNumber;
+    column_start: z.ZodNumber;
+    column_end: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    error: string;
+    error_type: string;
+    line_start: number;
+    line_end: number;
+    column_start: number;
+    column_end: number;
+}, {
+    message: string;
+    error: string;
+    error_type: string;
+    line_start: number;
+    line_end: number;
+    column_start: number;
+    column_end: number;
+}>;
+type FlowValidationError = z.infer<typeof flowValidationError>;
+
+type WhatsappGetManyFlowsRequestResponse = {
+    data: Array<{
+        id: string;
+        name: string;
+        status: FlowStatus;
+        categories: FlowCategory[];
+        validation_errors: FlowValidationError[];
+    }>;
+    paging: {
+        cursors: {
+            before: string;
+            after: string;
+        };
+    };
+};
+
+type WhatsappGetFlowWebPreviewPageRequestQuery = {
+    flow_token: string;
+    flow_action: "data_exchange" | "navigate";
+    phone_number: string;
+    flow_action_payload?: {
+        screen: string;
+        data: Record<string, AnyType>;
+    };
+    interactive?: boolean;
+};
+type WhatsappGetFlowWebPreviewURLResponse = {
+    id: string;
+    preview: {
+        preview_url: string;
+        expires_at: string;
+    };
+};
+
+type WhatsappGetFlowsRequestQuery = {
+    fields: string;
+};
+type WhatsappGetFlowsRequestResponse = {
+    id: string;
+    name: string;
+    status: FlowStatus;
+    categories: FlowCategory[];
+    validation_errors: FlowValidationError[];
+    json_version: string;
+    data_api_version: string;
+    endpoint_uri: string;
+    preview: WhatsappGetFlowWebPreviewURLResponse;
+    whatsapp_business_account: AnyType;
+    application: AnyType;
+    health_status: {
+        can_send_message: FlowCanSendMessageStatus;
+    };
+};
+
+type WhatsappPublishFlowResponse = {
+    success: boolean;
+};
+
+type WhatsappUpdateFlowJsonRequestBody = {
+    name: "flow.json";
+    asset_type: "FLOW_JSON";
+    file: AnyType;
+};
+type WhatsappUpdateFlowJsonResponse = {
+    success: boolean;
+    validation_errors: FlowValidationError[];
+};
+
+type WhatsappFlowUpdateMetadataRequestBody = {
+    name?: string;
+    categories?: FlowCategory[];
+    endpoint_uri?: string;
+    application_id?: string;
+};
+type WhatsappFlowUpdateMetadataResponse = {
+    success: boolean;
+};
+
+declare const flowsEndpoints: {
+    create: Endpoint<"/{waba_id}/flows", "post", {
+        body: WhatsappCreateFlowRequestBody;
+    }, WhatsappCreateFlowResponse>;
+    updateMetadata: Endpoint<"/{flow_id}", "post", {
+        body: WhatsappFlowUpdateMetadataRequestBody;
+    }, WhatsappFlowUpdateMetadataResponse>;
+    readMany: Endpoint<"/{waba_id}/flows", "get", IRequest, WhatsappGetManyFlowsRequestResponse>;
+    delete: Endpoint<"/{flow_id}", "delete", IRequest, WhatsappDeleteFlowResponse>;
+    read: Endpoint<"/{flow_id}", "get", {
+        query: WhatsappGetFlowsRequestQuery;
+    }, WhatsappGetManyFlowsRequestResponse>;
+    updateJson: Endpoint<"/{flow_id}/assets", "post", {
+        body: WhatsappUpdateFlowJsonRequestBody;
+    }, WhatsappUpdateFlowJsonResponse>;
+    getPreview: Endpoint<"/{flow_id}?fields=preview.invalidate(false)", "get", IRequest, WhatsappGetFlowWebPreviewURLResponse>;
+    publish: Endpoint<"/{flow_id}/publish", "post", IRequest, WhatsappPublishFlowResponse>;
+};
+
+declare const flowAction: z.ZodEnum<["INIT", "BACK", "data_exchange", "navigate", "ping"]>;
+type FlowAction = z.infer<typeof flowAction>;
+
+type FlowData<K extends string = string> = Record<K, AnyType>;
+
+declare const flowMediaData: z.ZodObject<{
+    media_id: z.ZodString;
+    cdn_url: z.ZodString;
+    file_name: z.ZodString;
+    encryption_metadata: z.ZodObject<{
+        encrypted_hash: z.ZodString;
+        iv: z.ZodString;
+        encryption_key: z.ZodString;
+        hmac_key: z.ZodString;
+        plaintext_hash: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        encrypted_hash: string;
+        iv: string;
+        encryption_key: string;
+        hmac_key: string;
+        plaintext_hash: string;
+    }, {
+        encrypted_hash: string;
+        iv: string;
+        encryption_key: string;
+        hmac_key: string;
+        plaintext_hash: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    media_id: string;
+    cdn_url: string;
+    file_name: string;
+    encryption_metadata: {
+        encrypted_hash: string;
+        iv: string;
+        encryption_key: string;
+        hmac_key: string;
+        plaintext_hash: string;
+    };
+}, {
+    media_id: string;
+    cdn_url: string;
+    file_name: string;
+    encryption_metadata: {
+        encrypted_hash: string;
+        iv: string;
+        encryption_key: string;
+        hmac_key: string;
+        plaintext_hash: string;
+    };
+}>;
+type FlowMediaData = z.infer<typeof flowMediaData>;
+
+declare const flowMetadata: z.ZodObject<{
+    name: z.ZodString;
+    categories: z.ZodArray<z.ZodEnum<["SIGN_UP", "SIGN_IN", "APPOINTMENT_BOOKING", "LEAD_GENERATION", "CONTACT_US", "CUSTOMER_SUPPORT", "SURVEY", "OTHER"]>, "many">;
+    application_id: z.ZodOptional<z.ZodString>;
+    endpoint_uri: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    categories: ("SIGN_UP" | "SIGN_IN" | "APPOINTMENT_BOOKING" | "LEAD_GENERATION" | "CONTACT_US" | "CUSTOMER_SUPPORT" | "SURVEY" | "OTHER")[];
+    application_id?: string | undefined;
+    endpoint_uri?: string | undefined;
+}, {
+    name: string;
+    categories: ("SIGN_UP" | "SIGN_IN" | "APPOINTMENT_BOOKING" | "LEAD_GENERATION" | "CONTACT_US" | "CUSTOMER_SUPPORT" | "SURVEY" | "OTHER")[];
+    application_id?: string | undefined;
+    endpoint_uri?: string | undefined;
+}>;
+type FlowMetadata = z.infer<typeof flowMetadata>;
+
+declare const flowScreen: z.ZodUnion<[z.ZodLiteral<"SUCCESS">, z.ZodString]>;
+type FlowScreen = z.infer<typeof flowScreen>;
+
+type WaOutgoingContactsMessage = Array<{
+    addresses: Array<Partial<{
+        street: string;
+        city: string;
+        state: string;
+        zip: string;
+        country: string;
+        country_code: string;
+        type: string;
+    }>>;
+    birthday: `${number}${number}${number}${number}-${number}${number}-${number}${number}`;
+    emails: Array<Partial<{
+        email: string;
+        type: string;
+    }>>;
+    name: {
+        formatted_name: string;
+        first_name?: string;
+        last_name?: string;
+        middle_name?: string;
+        prefix?: string;
+        suffix?: string;
+    };
+    org: Partial<{
+        company: string;
+        department: string;
+        title: string;
+    }>;
+    phones: Array<Partial<{
+        phone: string;
+        type: string;
+        wa_id: string;
+    }>>;
+    urls: Array<Partial<{
+        url: string;
+        type: string;
+    }>>;
+}>;
+
+type MediaTypes = "sticker" | "audio" | "document" | "image" | "video";
+type WaOutgoingImageMessage = {
+    id: string;
+    caption?: string;
+} | {
+    link: string;
+    caption?: string;
+};
+type WaOutgoingDocumentMessage = {
+    id: string;
+    caption?: string;
+    filename?: string;
+} | {
+    link: string;
+    caption?: string;
+    filename?: string;
+};
+type WaOutgoingAudioMessage = {
+    id: string;
+    caption?: string;
+} | {
+    link: string;
+    caption?: string;
+};
+type WaOutgoingVideoMessage = {
+    id: string;
+    caption?: string;
+} | {
+    link: string;
+    caption?: string;
+};
+type WaOutgoingStickerMessage = {
+    id: string;
+} | {
+    link: string;
+};
+
+interface WaInteractiveAction {
+    name?: "flow";
+    parameters?: {
+        flow_message_version?: "3";
+        flow_token?: string;
+        flow_name?: string;
+        flow_cta?: string;
+        flow_action?: "navigate" | "data_exchange";
+        flow_action_payload?: {
+            screen: string;
+            data?: Record<string, AnyType>;
+        };
+        mode: "draft" | "published";
+    };
+    button?: string;
+    buttons?: Array<{
+        type: "reply";
+        title: string;
+        id: string;
+    }>;
+    catalog_id?: string;
+    product_retailer_id?: string;
+    sections?: Array<{
+        product_items?: Array<{
+            product_retailer_id: string;
+        }>;
+        rows: Array<{
+            id: string;
+            title: string;
+            description?: string;
+        }>;
+        title: string;
+    }>;
+    mode?: "draft" | "published";
+}
+interface WaInteractiveBody {
+    text: string;
+}
+interface WaInteractiveFooter {
+    text: string;
+}
+interface WaInteractiveHeader {
+    document?: WaOutgoingDocumentMessage;
+    image?: WaOutgoingImageMessage;
+    video?: WaOutgoingVideoMessage;
+    text: string;
+    type: "text" | "video" | "image" | "document";
+}
+type WaInteractiveActionType = "button" | "catalog_message" | "list" | "product" | "product_list" | "flow";
+declare class WaInteractiveBase {
+    constructor({ type, body, footer, header, }: {
+        type: WaInteractiveActionType;
+        body?: WaInteractiveBody;
+        footer?: WaInteractiveFooter;
+        header?: WaInteractiveHeader;
+    });
+    type: WaInteractiveActionType;
+    body?: WaInteractiveBody;
+    footer?: WaInteractiveFooter;
+    header?: WaInteractiveHeader;
+}
+type WaOutgoingInteractiveMessage = WaInteractiveBase & {
+    action: WaInteractiveAction;
+};
+
+interface WaOutgoingLocationMessage {
+    latitude: number;
+    longitude: number;
+    name: string;
+    address: string;
+}
+
+interface WaOutgoingReactionMessage {
+    message_id: string;
+    emoji: string;
+}
+
+type WaOutgoingTemplateMessage = {
+    name: string;
+    language: {
+        code: string;
+    };
+    namespace?: string;
+    components?: Array<{
+        type: "header" | "body" | "footer";
+        parameters: Array<{
+            type: "text" | "image" | "video" | "document";
+            text?: string;
+            image?: WaOutgoingImageMessage;
+            video?: WaOutgoingDocumentMessage;
+            document?: WaOutgoingVideoMessage;
+        }>;
+    } | {
+        type: "button";
+        sub_type: "quick_reply" | "url" | "copy_code";
+        index: string;
+        parameters: Array<{
+            type: "payload" | "text" | "coupon_code";
+            payload?: string;
+            text?: string;
+            coupon_code?: string;
+        }>;
+    }>;
+};
+
+interface WaOutgoingTextMessage {
+    body: string;
+    preview_url?: boolean;
+}
+
+interface WaOutgoingMessage {
+    text?: WaOutgoingTextMessage;
+    contacts?: WaOutgoingContactsMessage;
+    reaction?: WaOutgoingReactionMessage;
+    location?: WaOutgoingLocationMessage;
+    audio?: WaOutgoingAudioMessage;
+    document?: WaOutgoingDocumentMessage;
+    image?: WaOutgoingImageMessage;
+    video?: WaOutgoingVideoMessage;
+    sticker?: WaOutgoingStickerMessage;
+    interactive?: WaOutgoingInteractiveMessage;
+    template?: WaOutgoingTemplateMessage;
+}
+type WaMessageType = keyof WaOutgoingMessage;
+
+interface WaIncomingContactObject {
+    wa_id: string;
+    profile: {
+        name: string;
+    };
+}
+type WaIncomingContacts = Array<WaIncomingContactObject>;
+
+type WhatsappSendMessageRequestConfig = {
+    to: string;
+    preview_url?: boolean;
+    context?: string;
+    biz_opaque_callback_data?: string;
+    recipient_type?: "individual";
+    messaging_product?: "whatsapp";
+};
+type WhatsappSendMessageRequestBody<T extends keyof WaOutgoingMessage> = {
+    type: T;
+} & WhatsappSendMessageRequestConfig & Record<T, WaOutgoingMessage[T]>;
+type WhatsappSendMessageResponse = {
+    messaging_product: "whatsapp";
+    contacts: WaIncomingContactObject[];
+    messages: Array<{
+        id: string;
+    }>;
+};
+
+declare const messagesEndpoints: {
+    send: Endpoint<"/{number_id}/messages", "post", {
+        body: WhatsappSendMessageRequestBody<any>;
+    }, WhatsappSendMessageResponse>;
+};
+
+type ISOCountryCode = "AU" | "ID" | "IN" | "JP" | "SG" | "KR" | "DE" | "CH" | "GB" | "BR" | "BH" | "ZA" | "AE" | "CA";
+
+type WhatsappRegisterPhoneNumberRequestBody = {
+    messaging_product: "whatsapp";
+    pin: string;
+    data_localization_region?: ISOCountryCode;
+};
+
+type WhatsappWabaUploadEncryptionRequestBody = {
+    business_public_key: string;
+};
+
+declare const wabaEndpoints: {
+    updateEncryption: Endpoint<"/{number_id}/whatsapp_business_encryption", "post", {
+        body: WhatsappWabaUploadEncryptionRequestBody;
+    }, unknown>;
+    registerNumber: Endpoint<"/{number_id}/register", "post", {
+        body: WhatsappRegisterPhoneNumberRequestBody;
+    }, unknown>;
+};
+
+type WaIncomingErrorObject = {
+    code: number;
+    title: string;
+    message: string;
+    error_data: {
+        details: string;
+    };
+};
+type WaIncomingErrors = Array<WaIncomingErrorObject>;
+
+type ConversationType = "authentication" | "service" | "utility" | "marketing" | "referral_conversation";
+type WaIncomingMessageStatus = "delivered" | "read" | "sent";
+type WaIncomingMessageStatuses = Array<{
+    id: string;
+    biz_opaque_callback_data: string;
+    conversation: {
+        id: string;
+        origin: {
+            type: ConversationType;
+        };
+        expiration_timestamp: number;
+    };
+    errors: WaIncomingErrors;
+    pricing: {
+        category: ConversationType;
+        pricing_model: "CBP";
+    };
+    recipient_id: string;
+    status: WaIncomingMessageStatus;
+    timestamp: number;
+}>;
+
+interface WaIncomingInteractiveObject {
+    type: "button_reply" | "list_reply" | "nfm_reply";
+    button_reply?: {
+        id: string;
+        title: string;
+    };
+    list_reply?: {
+        id: string;
+        title: string;
+        description: string;
+    };
+    nfm_reply?: {
+        response_json: string;
+        body: string;
+        name: "flow";
+    };
+}
+interface WaIncomingOrderObject {
+    catalog_id: string;
+    text: string;
+    product_items: Array<{
+        product_retailer_id: string;
+        quantity: number;
+        item_price: string;
+        currency: string;
+    }>;
+}
+interface WaIncomingReferralObject {
+    source_url: string;
+    source_type: string;
+    source_id: string;
+    headline: string;
+    body: string;
+    media_type: string;
+    image_url: string;
+    video_url: string;
+    thumbnail_url: string;
+    ctwa_clid: string;
+}
+interface WaIncomingStickerObject {
+    mime_type: string;
+    sha256: string;
+    id: string;
+    animated: string;
+}
+interface WaIncomingSystemObject {
+    body: string;
+    identity: string;
+    new_wa_id: string;
+    wa_id: string;
+    type: {
+        customer_changed_number: string;
+        customer_identity_changed: string;
+    };
+    customer_changed_number: string;
+    customer_identity_changed: string;
+    customer: string;
+}
+interface WaIncomingContextObject {
+    forwarded: boolean;
+    frequently_forwarded: boolean;
+    from: string;
+    id: string;
+    referred_product?: {
+        catalog_id: string;
+        product_retailer_id: string;
+    };
+}
+interface WaIncomingButtonObject {
+    payload: string;
+    text: string;
+}
+interface WaIncomingDocumentObject {
+    caption: string | null;
+    filename: string;
+    sha256: string;
+    mime_type: string;
+    id: string;
+}
+interface WaIncomingImageObject {
+    caption: string | null;
+    sha256: string;
+    id: string;
+    mime_type: string;
+}
+interface WaIncomingVideoObject {
+    id: string;
+    caption: string | null;
+    filename: string;
+    sha256: string;
+    mime_type: string;
+}
+interface WaIncomingAudioObject {
+    id: string;
+    mime_type: string;
+}
+interface WaIncomingIdentityObject {
+    acknowledged: boolean;
+    created_timestamp: number;
+    hash: string;
+}
+interface WaIncomingTextObject {
+    body: string;
+}
+type WaIncomingMessageType = "audio" | "button" | "document" | "text" | "image" | "interactive" | "order" | "sticker" | "system" | "unknown" | "video";
+type WaIncomingMessages = Array<{
+    id: string;
+    from: string;
+    timestamp: number;
+    type: WaIncomingMessageType;
+    context?: WaIncomingContextObject;
+    image?: WaIncomingImageObject;
+    video?: WaIncomingVideoObject;
+    interactive?: WaIncomingInteractiveObject;
+    order?: WaIncomingOrderObject;
+    referral?: WaIncomingReferralObject;
+    sticker?: WaIncomingStickerObject;
+    /**
+     * Sent when a customer changes their phone number or profile information.
+     */
+    system?: WaIncomingSystemObject;
+    text?: WaIncomingTextObject;
+    identity?: WaIncomingIdentityObject;
+    audio?: WaIncomingAudioObject;
+    button?: WaIncomingButtonObject;
+    document?: WaIncomingDocumentObject;
+    errors?: WaIncomingErrors;
+}>;
+
+interface MetadataObject {
+    /**
+     * Customer phone number
+     */
+    display_phone_number: string;
+    /**
+     * Customer phone number id
+     */
+    phone_number_id: string;
+}
+type MessageField = {
+    value: {
+        messaging_product: "whatsapp";
+        metadata: MetadataObject;
+        contacts: WaIncomingContacts;
+        errors?: WaIncomingErrors;
+        messages?: WaIncomingMessages;
+        statuses?: WaIncomingMessageStatuses;
+    };
+    field: "messages";
+};
+
+type WhatsappApplicationWebhookBody = {
+    /**
+     * Value will always be "whatsapp_business_account"
+     */
+    object: "whatsapp_business_account";
+    /**
+     * An array of entry objects. Each entry object contains an array of changes objects. Meta will send multiple entries in case there's a big load on their systems.
+     */
+    entry: Array<{
+        /**
+         * The WABA account id that is subscribed to the webhook. Useful when dealing with multiple numbers within the same company.
+         */
+        id: string;
+        /**
+         * An array of changes objects. Each changes object contains the value of the change and the field that was changed. Meta will send multiple changes in case there's a big load on their systems.
+         */
+        changes: Array<MessageField>;
+    }>;
+};
+
+interface WhatsappFlowDecryptedWebhookBody {
+    version: "3.0";
+    screen: FlowScreen;
+    action: FlowAction;
+    data: Record<string, AnyType>;
+    flow_token: string;
+}
+interface WhatsappFlowResponse {
+    screen: FlowScreen;
+    data: Record<string, AnyType>;
+}
+interface WhatsappFlowPingResponse {
+    data: {
+        status: "active";
+    };
+}
+interface WhatsappFlowEncryptionData {
+    aesKeyBuffer: Buffer;
+    initialVectorBuffer: Buffer;
+}
+interface WhatsappFlowEncryptedWebhookBody {
+    encrypted_aes_key: string;
+    encrypted_flow_data: string;
+    initial_vector: string;
+}
+type WhatsappFlowErrorMessages<T> = Partial<Record<keyof T, string>>;
+interface WhatsappFlowInfo {
+    id: string;
+    mode: "draft" | "published";
+    name: string;
+}
+
+declare function _delete(flow_id: string): Promise<WhatsappDeleteFlowResponse>;
+
+declare function verifyFlowIntegrity(flowID: string): Promise<string | void>;
+
+declare const unnoficial_verifyFlowIntegrity: typeof verifyFlowIntegrity;
+declare namespace unnoficial {
+  export { unnoficial_verifyFlowIntegrity as verifyFlowIntegrity };
+}
+
+type WaSDKButtonMessage = Omit<WaInteractiveBase, "type"> & {
+    type: "button";
+    buttons: Array<{
+        id: string;
+        text: string;
+    }>;
+};
+
+interface FlowPayload {
+    screen: string;
+    data?: Record<string, AnyType>;
+}
+interface BaseFlowConfig {
+    name: string;
+    buttonText: string;
+    parameters?: Record<string, string | number>;
+    mode?: "draft" | "published";
+}
+interface NavigateFlowConfig extends BaseFlowConfig {
+    action?: "navigate";
+    payload: FlowPayload;
+}
+interface DataExchangeFlowConfig extends BaseFlowConfig {
+    action?: "data_exchange";
+    payload?: FlowPayload;
+}
+type FlowConfig = NavigateFlowConfig | DataExchangeFlowConfig;
+type WaSDKOutgoingFlowMessage = Omit<WaInteractiveBase, "type"> & {
+    type: "flow";
+    flow: FlowConfig;
+};
+
+type WaSDKOutgoingListMessage = Omit<WaInteractiveBase, "type"> & {
+    type: "list";
+    list: {
+        buttonText: string;
+        sections: Array<{
+            rows: Array<{
+                id: string;
+                title: string;
+                description?: string;
+            }>;
+            title: string;
+        }>;
+    };
+};
+
+type WaSDKOutgoingMediaMessage = {
+    type: "media";
+    sticker: {
+        ref: string;
+    };
+} | {
+    type: "media";
+    image: {
+        ref: string;
+        caption?: string;
+    };
+} | {
+    type: "media";
+    document: {
+        ref: string;
+        caption?: string;
+        filename?: string;
+    };
+} | {
+    type: "media";
+    audio: {
+        ref: string;
+        caption?: string;
+    };
+} | {
+    type: "media";
+    video: {
+        ref: string;
+        caption?: string;
+    };
+};
+
+type WaSDKOutgoingTemplateMessage = Omit<WaOutgoingTemplateMessage, "namespace" | "language"> & {
+    type: "template";
+    language: string;
+};
+
+type WaSDKOutgoingTextMessage = {
+    type: "text";
+    text: string;
+    previewUrl?: boolean;
+};
+
+type WaSDKSendMessageData = WaSDKButtonMessage | WaSDKOutgoingFlowMessage | WaSDKOutgoingListMessage | WaSDKOutgoingTextMessage | WaSDKOutgoingTemplateMessage | WaSDKOutgoingMediaMessage;
+
+interface WaSDKSendMessageConfig {
+    showUrlPreviewImage?: boolean;
+    metadata?: string;
+    to: string;
+    reply?: string;
+}
+type WaSDKSendMessageBody = WaSDKSendMessageConfig & {
+    message: WaSDKSendMessageData;
+};
+
+declare function send(body: WaSDKSendMessageBody): Promise<WhatsappSendMessageResponse>;
+
+declare function uploadWabaEncryption(publicKey: string): Promise<unknown>;
+
+interface Payload {
+    pin: string;
+    dataRegion?: ISOCountryCode;
+}
+declare function registerNumber({ dataRegion, pin }: Payload): Promise<unknown>;
+
+declare const actions: {
+    messages: {
+        send: typeof send;
+    };
+    flows: {
+        unnoficial: typeof unnoficial;
+        create(body: WhatsappCreateFlowRequestBody): Promise<WhatsappCreateFlowResponse>;
+        updateMetadata(flow_id: string, body: WhatsappFlowUpdateMetadataRequestBody): Promise<WhatsappFlowUpdateMetadataResponse>;
+        updateJson(flow_id: string, json: Record<string, AnyType>): Promise<WhatsappUpdateFlowJsonResponse>;
+        getPreview(flow_id: string, query?: WhatsappGetFlowWebPreviewPageRequestQuery): Promise<string>;
+        get(flow_id: string, query?: {
+            fields: Array<keyof WhatsappGetFlowsRequestResponse>;
+        }): Promise<WhatsappGetManyFlowsRequestResponse>;
+        getMany(): Promise<WhatsappGetManyFlowsRequestResponse>;
+        publish(flow_id: string): Promise<WhatsappPublishFlowResponse>;
+        delete: typeof _delete;
+    };
+    waba: {
+        registerNumber: typeof registerNumber;
+        encryption: {
+            upload: typeof uploadWabaEncryption;
+        };
+    };
+};
+
+interface BaseMessageReceivedEventPayload {
+    id: string;
+    type: WaIncomingMessageType;
+    timestamp: number;
+    metadata: {
+        forwarded?: boolean;
+        frequentlyForwarded?: boolean;
+    };
+}
+type MessageReceivedEventPayload = BaseMessageReceivedEventPayload & {
+    chatId: string;
+    text: string | null;
+    reply?: string;
+    interaction?: {
+        button?: {
+            id: string | null;
+            title: string;
+            payload: string | null;
+        };
+        selectedOption?: {
+            id: string;
+            title: string;
+            description: string;
+        };
+        flowResponse?: {
+            flow_token: string;
+            intent: string | null;
+        } & {
+            [key: string]: AnyType;
+        };
+    };
+    media?: {
+        id: string;
+        caption: string | null;
+        mime_type: string;
+        type: "audio" | "document" | "image" | "video";
+        filename?: string;
+        sha256?: string;
+    };
+};
+
+interface MessageStatusUpdateEvent {
+    messageId: string;
+    metadata: string;
+    timestamp: number;
+    errors: WaIncomingErrors;
+    status: WaIncomingMessageStatuses;
+}
+
+type WaSDKFlowPayload = WhatsappFlowDecryptedWebhookBody;
+type WaSDKFlowDecryptedWebhookBody = {
+    payload: WaSDKFlowPayload;
+    encryptionMetadata: WhatsappFlowEncryptionData;
+};
+type WaSDKFlowExchangeEventPayload = WaSDKFlowDecryptedWebhookBody & {
+    pingResponse: WhatsappFlowPingResponse;
+};
+
+type FlowUpdateEventPayload = {
+    event: string;
+    message: string;
+    flow_id: string;
+};
+
+interface WaSDKEventPayload {
+    healthCheck: string;
+    flowExchange: WaSDKFlowExchangeEventPayload;
+    application: {
+        errors?: WaIncomingErrors[];
+        profileUpdate?: BaseMessageReceivedEventPayload & {
+            identity: WaIncomingIdentityObject;
+            system: WaIncomingSystemObject;
+        }[];
+        messageStatusUpdate?: MessageStatusUpdateEvent[];
+        messageReceived?: MessageReceivedEventPayload[];
+        flowUpdate?: FlowUpdateEventPayload[];
+    };
+}
+type WaSDKEventType = keyof WaSDKEventPayload;
+interface WaSDKEvent<T extends WaSDKEventType = WaSDKEventType> {
+    type: T;
+    payload: WaSDKEventPayload[T];
+}
+
+declare function webhook(request: Request): Promise<WaSDKEvent<"healthCheck"> | WaSDKEvent<"application"> | WaSDKEvent<"flowExchange">>;
+
+declare const parsers: {
+    toGraph: {
+        sendMessage: (body: WaSDKSendMessageBody) => WhatsappSendMessageRequestBody<any> | WhatsappSendMessageRequestBody<"interactive"> | WhatsappSendMessageRequestBody<"text"> | WhatsappSendMessageRequestBody<"template">;
+        flowResponse: (flow_token: string, response: WhatsappFlowResponse) => WhatsappFlowResponse;
+    };
+    toSDK: {
+        webhook: typeof webhook;
+    };
+};
+
+type MessageReceivedEvent = Defined<WaSDKEventPayload["application"]["messageReceived"]>[0];
+
+type WaSDKGetFlowWebPreviewPageRequestQuery = {
+    flow_action: "data_exchange" | "navigate";
+    phone_number: string;
+    interactive?: boolean;
+    recipient_id?: string;
+    flow_action_payload?: {
+        screen: string;
+        data: Record<string, AnyType>;
+    };
+    flow_parameters?: FlowParameters;
+};
+type FlowParameters = Record<string, string | number>;
+
+declare function decryptFlowBody(body: WhatsappFlowEncryptedWebhookBody): WaSDKFlowDecryptedWebhookBody;
+
+declare function decryptFlowMedia(media: FlowMediaData[]): Promise<Buffer<ArrayBufferLike>[]>;
+
+declare function encryptFlowResponse(data: AnyType, encryptionMetadata: {
+    aesKeyBuffer: Buffer;
+    initialVectorBuffer: Buffer;
+}): string;
+
+declare function generateWabaEncryption(): Promise<{
+    passphrase: `${string}-${string}-${string}-${string}-${string}`;
+    publicKey: string;
+    privateKey: string;
+}>;
+
+declare function verifyHub(request: Request): string | false;
+
+type WebhookSignatureChallengeArguments = {
+    rawBody: string;
+    untrustedSignature: string;
+};
+declare function verifySignature(request: Request, rawBody: string): Promise<boolean>;
+
+declare const security: {
+    verifyHub: typeof verifyHub;
+    verifySignature: typeof verifySignature;
+    generateWabaEncryption: typeof generateWabaEncryption;
+    decryptFlowBody: typeof decryptFlowBody;
+    encryptFlowResponse: typeof encryptFlowResponse;
+    decryptFlowMedia: typeof decryptFlowMedia;
+};
+
+declare const flows: {
+    createToken: ({ flow_name, flow_parameters, chatId, }: {
+        flow_name: string;
+        flow_parameters?: Record<string, string | number>;
+        chatId: string;
+    }) => string;
+    getName: (token: string) => string;
+    destructureFlowToken: (token: string) => {
+        paramsString: string;
+        flowName: string;
+        chatId: string;
+        flowIdentifier: string;
+        flowParameters: Record<string, string>;
+    };
+};
+
+declare const utils: {
+    flows: {
+        createToken: ({ flow_name, flow_parameters, chatId, }: {
+            flow_name: string;
+            flow_parameters?: Record<string, string | number>;
+            chatId: string;
+        }) => string;
+        getName: (token: string) => string;
+        destructureFlowToken: (token: string) => {
+            paramsString: string;
+            flowName: string;
+            chatId: string;
+            flowIdentifier: string;
+            flowParameters: Record<string, string>;
+        };
+    };
+};
+
+type sdk_BaseMessageReceivedEventPayload = BaseMessageReceivedEventPayload;
+type sdk_DataExchangeFlowConfig = DataExchangeFlowConfig;
+type sdk_FlowConfig = FlowConfig;
+type sdk_FlowParameters = FlowParameters;
+type sdk_FlowUpdateEventPayload = FlowUpdateEventPayload;
+type sdk_MessageReceivedEvent = MessageReceivedEvent;
+type sdk_MessageReceivedEventPayload = MessageReceivedEventPayload;
+type sdk_MessageStatusUpdateEvent = MessageStatusUpdateEvent;
+type sdk_NavigateFlowConfig = NavigateFlowConfig;
+type sdk_WaSDKButtonMessage = WaSDKButtonMessage;
+type sdk_WaSDKEvent<T extends WaSDKEventType = WaSDKEventType> = WaSDKEvent<T>;
+type sdk_WaSDKEventPayload = WaSDKEventPayload;
+type sdk_WaSDKEventType = WaSDKEventType;
+type sdk_WaSDKFlowDecryptedWebhookBody = WaSDKFlowDecryptedWebhookBody;
+type sdk_WaSDKFlowExchangeEventPayload = WaSDKFlowExchangeEventPayload;
+type sdk_WaSDKFlowPayload = WaSDKFlowPayload;
+type sdk_WaSDKGetFlowWebPreviewPageRequestQuery = WaSDKGetFlowWebPreviewPageRequestQuery;
+type sdk_WaSDKOutgoingFlowMessage = WaSDKOutgoingFlowMessage;
+type sdk_WaSDKOutgoingListMessage = WaSDKOutgoingListMessage;
+type sdk_WaSDKOutgoingMediaMessage = WaSDKOutgoingMediaMessage;
+type sdk_WaSDKOutgoingTemplateMessage = WaSDKOutgoingTemplateMessage;
+type sdk_WaSDKOutgoingTextMessage = WaSDKOutgoingTextMessage;
+type sdk_WaSDKSendMessageBody = WaSDKSendMessageBody;
+type sdk_WaSDKSendMessageConfig = WaSDKSendMessageConfig;
+type sdk_WaSDKSendMessageData = WaSDKSendMessageData;
+type sdk_WebhookSignatureChallengeArguments = WebhookSignatureChallengeArguments;
+declare const sdk_actions: typeof actions;
+declare const sdk_flows: typeof flows;
+declare const sdk_parsers: typeof parsers;
+declare const sdk_security: typeof security;
+declare const sdk_utils: typeof utils;
+declare namespace sdk {
+  export { type sdk_BaseMessageReceivedEventPayload as BaseMessageReceivedEventPayload, type sdk_DataExchangeFlowConfig as DataExchangeFlowConfig, type sdk_FlowConfig as FlowConfig, type sdk_FlowParameters as FlowParameters, type sdk_FlowUpdateEventPayload as FlowUpdateEventPayload, type sdk_MessageReceivedEvent as MessageReceivedEvent, type sdk_MessageReceivedEventPayload as MessageReceivedEventPayload, type sdk_MessageStatusUpdateEvent as MessageStatusUpdateEvent, type sdk_NavigateFlowConfig as NavigateFlowConfig, type sdk_WaSDKButtonMessage as WaSDKButtonMessage, type sdk_WaSDKEvent as WaSDKEvent, type sdk_WaSDKEventPayload as WaSDKEventPayload, type sdk_WaSDKEventType as WaSDKEventType, type sdk_WaSDKFlowDecryptedWebhookBody as WaSDKFlowDecryptedWebhookBody, type sdk_WaSDKFlowExchangeEventPayload as WaSDKFlowExchangeEventPayload, type sdk_WaSDKFlowPayload as WaSDKFlowPayload, type sdk_WaSDKGetFlowWebPreviewPageRequestQuery as WaSDKGetFlowWebPreviewPageRequestQuery, type sdk_WaSDKOutgoingFlowMessage as WaSDKOutgoingFlowMessage, type sdk_WaSDKOutgoingListMessage as WaSDKOutgoingListMessage, type sdk_WaSDKOutgoingMediaMessage as WaSDKOutgoingMediaMessage, type sdk_WaSDKOutgoingTemplateMessage as WaSDKOutgoingTemplateMessage, type sdk_WaSDKOutgoingTextMessage as WaSDKOutgoingTextMessage, type sdk_WaSDKSendMessageBody as WaSDKSendMessageBody, type sdk_WaSDKSendMessageConfig as WaSDKSendMessageConfig, type sdk_WaSDKSendMessageData as WaSDKSendMessageData, type sdk_WebhookSignatureChallengeArguments as WebhookSignatureChallengeArguments, sdk_actions as actions, sdk_flows as flows, sdk_parsers as parsers, sdk_security as security, sdk_utils as utils };
+}
+
+declare const whatsapp: {
+    graph: {
+        endpoints: {
+            flows: {
+                create: Endpoint<"/{waba_id}/flows", "post", {
+                    body: WhatsappCreateFlowRequestBody;
+                }, WhatsappCreateFlowResponse>;
+                updateMetadata: Endpoint<"/{flow_id}", "post", {
+                    body: WhatsappFlowUpdateMetadataRequestBody;
+                }, WhatsappFlowUpdateMetadataResponse>;
+                readMany: Endpoint<"/{waba_id}/flows", "get", IRequest, WhatsappGetManyFlowsRequestResponse>;
+                delete: Endpoint<"/{flow_id}", "delete", IRequest, WhatsappDeleteFlowResponse>;
+                read: Endpoint<"/{flow_id}", "get", {
+                    query: WhatsappGetFlowsRequestQuery;
+                }, WhatsappGetManyFlowsRequestResponse>;
+                updateJson: Endpoint<"/{flow_id}/assets", "post", {
+                    body: WhatsappUpdateFlowJsonRequestBody;
+                }, WhatsappUpdateFlowJsonResponse>;
+                getPreview: Endpoint<"/{flow_id}?fields=preview.invalidate(false)", "get", IRequest, WhatsappGetFlowWebPreviewURLResponse>;
+                publish: Endpoint<"/{flow_id}/publish", "post", IRequest, WhatsappPublishFlowResponse>;
+            };
+            messages: {
+                send: Endpoint<"/{number_id}/messages", "post", {
+                    body: WhatsappSendMessageRequestBody<any>;
+                }, WhatsappSendMessageResponse>;
+            };
+            waba: {
+                updateEncryption: Endpoint<"/{number_id}/whatsapp_business_encryption", "post", {
+                    body: WhatsappWabaUploadEncryptionRequestBody;
+                }, unknown>;
+                registerNumber: Endpoint<"/{number_id}/register", "post", {
+                    body: WhatsappRegisterPhoneNumberRequestBody;
+                }, unknown>;
+            };
+        };
+    };
+    settings: {
+        setup: (stg?: Partial<WhatsappSDKSettings>) => void;
+        get: (key: keyof WhatsappSDKSettings) => string;
+    };
+    sdk: typeof sdk;
+};
+
+export { type BaseMessageReceivedEventPayload, type ConversationType, type DataExchangeFlowConfig, type FlowAction, type FlowCanSendMessageStatus, type FlowCategory, type FlowConfig, type FlowData, type FlowMediaData, type FlowMetadata, type FlowParameters, type FlowScreen, type FlowStatus, type FlowUpdateEventPayload, type FlowValidationError, type ISOCountryCode, type MediaTypes, type MessageField, type MessageReceivedEvent, type MessageReceivedEventPayload, type MessageStatusUpdateEvent, type MetadataObject, type NavigateFlowConfig, type WaIncomingAudioObject, type WaIncomingButtonObject, type WaIncomingContactObject, type WaIncomingContacts, type WaIncomingContextObject, type WaIncomingDocumentObject, type WaIncomingErrorObject, type WaIncomingErrors, type WaIncomingIdentityObject, type WaIncomingImageObject, type WaIncomingInteractiveObject, type WaIncomingMessageStatus, type WaIncomingMessageStatuses, type WaIncomingMessageType, type WaIncomingMessages, type WaIncomingOrderObject, type WaIncomingReferralObject, type WaIncomingStickerObject, type WaIncomingSystemObject, type WaIncomingTextObject, type WaIncomingVideoObject, type WaInteractiveAction, type WaInteractiveActionType, WaInteractiveBase, type WaInteractiveBody, type WaInteractiveFooter, type WaInteractiveHeader, type WaMessageType, type WaOutgoingAudioMessage, type WaOutgoingContactsMessage, type WaOutgoingDocumentMessage, type WaOutgoingImageMessage, type WaOutgoingInteractiveMessage, type WaOutgoingLocationMessage, type WaOutgoingMessage, type WaOutgoingReactionMessage, type WaOutgoingStickerMessage, type WaOutgoingTemplateMessage, type WaOutgoingTextMessage, type WaOutgoingVideoMessage, type WaSDKButtonMessage, type WaSDKEvent, type WaSDKEventPayload, type WaSDKEventType, type WaSDKFlowDecryptedWebhookBody, type WaSDKFlowExchangeEventPayload, type WaSDKFlowPayload, type WaSDKGetFlowWebPreviewPageRequestQuery, type WaSDKOutgoingFlowMessage, type WaSDKOutgoingListMessage, type WaSDKOutgoingMediaMessage, type WaSDKOutgoingTemplateMessage, type WaSDKOutgoingTextMessage, type WaSDKSendMessageBody, type WaSDKSendMessageConfig, type WaSDKSendMessageData, type WebhookSignatureChallengeArguments, type WhatsappApplicationWebhookBody, type WhatsappCreateFlowRequestBody, type WhatsappCreateFlowResponse, type WhatsappDeleteFlowResponse, type WhatsappFlowDecryptedWebhookBody, type WhatsappFlowEncryptedWebhookBody, type WhatsappFlowEncryptionData, type WhatsappFlowErrorMessages, type WhatsappFlowInfo, type WhatsappFlowPingResponse, type WhatsappFlowResponse, type WhatsappFlowUpdateMetadataRequestBody, type WhatsappFlowUpdateMetadataResponse, type WhatsappGetFlowWebPreviewPageRequestQuery, type WhatsappGetFlowWebPreviewURLResponse, type WhatsappGetFlowsRequestQuery, type WhatsappGetFlowsRequestResponse, type WhatsappGetManyFlowsRequestResponse, type WhatsappPublishFlowResponse, type WhatsappRegisterPhoneNumberRequestBody, type WhatsappSendMessageRequestBody, type WhatsappSendMessageRequestConfig, type WhatsappSendMessageResponse, type WhatsappUpdateFlowJsonRequestBody, type WhatsappUpdateFlowJsonResponse, type WhatsappWabaUploadEncryptionRequestBody, actions, endpoints, flowAction, flowCanSendMessageStatus, flowCategory, flowMediaData, flowMetadata, flowScreen, flowStatus, flowValidationError, flows, flowsEndpoints, messagesEndpoints, parsers, security, utils, wabaEndpoints, whatsapp };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@apostlejs/whatsapp",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.0.0",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": "./dist/index.cjs"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.cts"
+      ]
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.1",
+    "barrelsmith": "0.0.6",
+    "concurrently": "9.1.1",
+    "terser": "^5.39.0",
+    "tsup": "8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "5.8.2",
+    "@apostlejs/config": "1.0.0"
+  },
+  "dependencies": {
+    "dotenv": "16.4.7",
+    "zod": "3.24.2"
+  },
+  "scripts": {
+    "------------- toolchain -------------": "-------------",
+    "format": "biome format --write",
+    "lint": "biome lint --error-on-warnings",
+    "typecheck": "tsc --noEmit",
+    "------------- dev -------------": "-------------",
+    "dev:barrelsmith": "barrelsmith --watch",
+    "dev:watch": "pnpm tsup --env.mode dev",
+    "dev": "concurrently --raw pnpm:dev:*",
+    "------------- build -------------": "-------------",
+    "build": "rm -rf dist && barrelsmith && pnpm tsup --env.mode release",
+    "bundlesize": "pnpm build --metafile && npm pack --dry-run",
+    "bundlesize:dev": "pnpm tsup --metafile && npm pack --dry-run",
+    "------------- publishing -------------": "-------------",
+    "change": "changeset",
+    "bump": "pnpm changeset version",
+    "release": "pnpm typecheck && pnpm build && pnpm publish --no-git-checks",
+    "release:rc": "pnpm typecheck && pnpm build && pnpm version prerelease --preid=rc"
+  }
+}