@apostlejs/flows 0.0.3

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-to-json-schema"),t=require("zod"),n=require("@apostlejs/whatsapp"),o=require("node:util"),a=Object.defineProperty,i={"*":["name","type","on-click-action","on-select-action","on-unselect-action","input-type","markdown","media-size","font-weight","Then","Else","Cases","children","max-file-size-kb"],Footer:["center-caption","left-caption","right-caption"],PhotoPicker:["min-uploaded-photos","max-uploaded-photos","photo-source","required"],Image:["scale-type"],TextArea:["max-length","label-variant"],TextInput:["label-variant"]},r=Object.values(i).flat(),s=t=>{const n=e.zodToJsonSchema(t,{$refStrategy:"none"}),o=(e,t=0)=>{if("object"!=typeof e||null===e)return e;const n=new Set([...r,"additionalProperties","required","enum","$schema"]),a=Object.fromEntries(Object.entries(e).filter((([e])=>!n.has(e))));if(a.properties&&"object"==typeof a.properties){const e={};for(const[n,i]of Object.entries(a.properties))e[n]=o(i,t+1);a.properties=e}a.items&&(a.items=o(a.items,t+1));const i=e.type??"object",s={string:"example",boolean:!0,number:42,integer:1,array:[],object:{}}[i]??null;return 0===t?{type:i,...a,__example__:s}:{type:i,...a}};return o(n)},l={Title:t.z.object({type:t.z.literal("Title"),id:t.z.string(),text:t.z.string()})},c=t.z.enum(["data_exchange","navigate","complete","update_data","open_url"]),p=t.z.object({name:c,payload:t.z.record(t.z.any()).optional(),next:t.z.object({type:t.z.literal("screen"),name:t.z.string()}).optional(),url:t.z.string().optional()}),d=p.extend({name:t.z.union([t.z.literal("update_data"),t.z.literal("data_exchange")])}),u=p.extend({name:t.z.literal("update_data")}),m=t.z.object({visible:t.z.boolean().optional()}),g=t.z.object({type:t.z.literal("Form"),name:t.z.string().optional(),children:t.z.array(t.z.any()).optional(),"error-messages":t.z.record(t.z.any()).optional(),"init-values":t.z.record(t.z.any()).optional()}),z=t.z.object({name:t.z.string(),required:t.z.boolean().optional(),enabled:t.z.boolean().optional(),"error-message":t.z.string().optional(),"init-value":t.z.string().optional()}).merge(m),f=t.z.object({id:t.z.string(),title:t.z.string(),description:t.z.string().optional(),metadata:t.z.string().optional(),enabled:t.z.boolean().optional(),image:t.z.string().optional(),"alt-text":t.z.string().optional(),color:t.z.string().optional(),"on-click-action":p.optional(),"on-select-action":u.optional(),"on-unselect-action":u.optional()}),b=z.merge(t.z.object({label:t.z.string(),description:t.z.string().optional(),"data-source":t.z.array(f),"media-size":t.z.enum(["regular","large"]).optional(),"on-click-action":p.optional(),"on-select-action":d.optional(),"on-unselect-action":d.optional()})),y=z.merge(t.z.object({type:t.z.literal("TextInput"),label:t.z.string(),"label-variant":t.z.enum(["large"]).optional(),"input-type":t.z.enum(["text","number","email","password","passcode","phone"]).optional(),pattern:t.z.string().optional(),"helper-text":t.z.string().optional(),"min-chars":t.z.number().optional(),"max-chars":t.z.number().optional()})),h=z.merge(t.z.object({type:t.z.literal("TextArea"),label:t.z.string(),"label-variant":t.z.enum(["large"]).optional(),"max-length":t.z.number().optional(),"helper-text":t.z.string().optional()})),x=b.merge(t.z.object({type:t.z.literal("CheckboxGroup"),"min-selected-items":t.z.number().optional(),"max-selected-items":t.z.number().optional()})),w=b.merge(t.z.object({type:t.z.literal("RadioButtonsGroup")})),v=z.merge(t.z.object({type:t.z.literal("Dropdown"),label:t.z.string(),"data-source":t.z.array(f),"on-click-action":p.optional(),"on-select-action":d.optional(),"on-unselect-action":d.optional()})),j=z.merge(t.z.object({type:t.z.literal("DatePicker"),label:t.z.string(),"min-date":t.z.string().optional(),"max-date":t.z.string().optional(),"unavailable-dates":t.z.array(t.z.string()).optional(),"helper-text":t.z.string().optional(),"on-select-action":d.optional()})),k=z.merge(t.z.object({type:t.z.literal("CalendarPicker"),title:t.z.string().optional(),description:t.z.string().optional(),label:t.z.string(),"helper-text":t.z.string().optional(),mode:t.z.enum(["single","range"]).default("single").optional(),"min-date":t.z.string().optional(),"max-date":t.z.string().optional(),"unavailable-dates":t.z.array(t.z.string()).optional(),"include-days":t.z.array(t.z.enum(["Mon","Tue","Wed","Thu","Fri","Sat","Sun"])).optional(),"min-days":t.z.number().optional(),"max-days":t.z.number().optional(),"on-select-action":d.optional()})),_=z.merge(t.z.object({type:t.z.literal("ChipsSelector"),label:t.z.string(),description:t.z.string().optional(),"data-source":t.z.array(f),"min-selected-items":t.z.number().optional(),"max-selected-items":t.z.number().optional(),"on-click-action":p.optional(),"on-select-action":d.optional(),"on-unselect-action":d.optional()})),$={Form:g,TextInput:y,TextArea:h,CheckboxGroup:x,RadioButtonsGroup:w,Dropdown:v,DatePicker:j,CalendarPicker:k,OptIn:z.omit({enabled:!0}).merge(t.z.object({type:t.z.literal("OptIn"),label:t.z.string(),"on-click-action":p.optional(),"on-select-action":d.optional(),"on-unselect-action":d.optional()})),NavigationList:t.z.object({type:t.z.literal("NavigationList"),name:t.z.string(),"list-items":t.z.array(t.z.object({id:t.z.string(),"main-content":t.z.object({title:t.z.string(),description:t.z.string().optional(),metadata:t.z.string().optional()}),end:t.z.object({title:t.z.string().optional(),description:t.z.string().optional(),metadata:t.z.string().optional()}).optional(),start:t.z.object({image:t.z.string().optional(),"alt-text":t.z.string().optional()}).optional(),badge:t.z.string().optional(),tags:t.z.array(t.z.string()).optional(),"on-click-action":p.optional()})),label:t.z.string().optional(),description:t.z.string().optional(),"media-size":t.z.enum(["regular","large"]).default("regular").optional(),"on-click-action":p.optional()}),ChipsSelector:_,PhotoPicker:z.merge(t.z.object({type:t.z.literal("PhotoPicker"),label:t.z.string(),description:t.z.string().max(300).optional(),"photo-source":t.z.enum(["camera_gallery","camera","gallery"]).default("camera_gallery").optional(),"max-file-size-kb":t.z.number().int().min(1).max(25600).default(25600).optional(),"min-uploaded-photos":t.z.number().int().min(0).max(30).default(0).optional(),"max-uploaded-photos":t.z.number().int().min(1).max(30).default(30).optional()})),DocumentPicker:z.merge(t.z.object({type:t.z.literal("DocumentPicker"),label:t.z.string(),description:t.z.string().max(300).optional(),"max-file-size-kb":t.z.number().int().min(1).max(25600).default(25600).optional(),"min-uploaded-documents":t.z.number().int().min(0).max(30).default(0).optional(),"max-uploaded-documents":t.z.number().int().min(1).max(30).default(30).optional(),"allowed-mime-types":t.z.array(t.z.enum(["application/gzip","application/msword","application/pdf","application/vnd.ms-excel","application/vnd.ms-powerpoint","application/vnd.oasis.opendocument.presentation","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/x-7z-compressed","application/zip","image/avif","image/gif","image/heic","image/heif","image/jpeg","image/png","image/tiff","image/webp","text/plain","video/mp4","video/mpeg"])).optional()}))},C={Footer:t.z.object({type:t.z.literal("Footer"),label:t.z.string(),enabled:t.z.boolean().optional(),"left-caption":t.z.string().optional(),"center-caption":t.z.string().optional(),"right-caption":t.z.string().optional(),"on-click-action":p.optional()}),If:t.z.object({type:t.z.literal("If"),condition:t.z.string(),Then:t.z.array(t.z.any()),Else:t.z.array(t.z.any()).optional()}),Switch:t.z.object({type:t.z.literal("Switch"),value:t.z.string(),Cases:t.z.record(t.z.array(t.z.any()))})},S=t.z.object({id:t.z.string(),text:t.z.string()}).merge(m),O=t.z.enum(["bold","italic","bold_italic","normal"]),T={TextHeading:t.z.object({type:t.z.literal("TextHeading")}).merge(S),TextSubheading:t.z.object({type:t.z.literal("TextSubheading"),text:t.z.string()}).merge(S),TextBody:t.z.object({type:t.z.literal("TextBody"),"font-weight":O.optional(),strikethrough:t.z.boolean().optional(),markdown:t.z.boolean().optional()}).merge(S),TextCaption:t.z.object({type:t.z.literal("TextCaption"),"font-weight":O.optional(),strikethrough:t.z.boolean().optional(),markdown:t.z.boolean().optional()}).merge(S),RichText:t.z.object({type:t.z.literal("RichText"),id:t.z.string().optional()}).merge(S),EmbeddedLink:t.z.object({type:t.z.literal("EmbeddedLink"),text:t.z.string(),"on-click-action":p.optional()}).merge(S),Image:t.z.object({type:t.z.literal("Image"),id:t.z.string(),src:t.z.string(),width:t.z.number().optional(),height:t.z.number().optional(),"scale-type":t.z.enum(["cover","contain"]).default("contain").optional(),"aspect-ratio":t.z.number().default(1).optional(),"alt-text":t.z.string().optional()}),ImageCarousel:t.z.object({type:t.z.literal("ImageCarousel"),images:t.z.array(t.z.object({src:t.z.string(),"alt-text":t.z.string()})),"scale-type":t.z.enum(["cover","contain"]).default("contain").optional(),"aspect-ratio":t.z.enum(["4:3","16:9"]).optional()})},E={...$,...C,...T,...l},I=Object.entries(E).reduce(((e,[t,n])=>(e[t]=s(n),e)),{});function F(e,t){const n={};for(const{identifier:e,type:o}of t){const t=I[o];n[e]=t?.properties?{...t,properties:Object.fromEntries(Object.entries(t.properties).map((([e,t])=>[e.replaceAll("-","_"),t])))}:t}if(e){const t=s(e).properties,o=Object.entries(t).reduce(((e,[t,n])=>{e[t]=n;const o=n=>{e[t].__example__=n};switch(e[t].type){case"number":o(0);break;case"string":default:o("");break;case"array":o([]);break;case"boolean":o(!0);break;case"object":o({})}return e}),{});Object.assign(n,o)}return n}function P(e,t){t in e&&delete e[t]}var D=["If","Switch"],N=["children","Then","Else","Cases"],q=(e,t)=>{const n=[],o=e=>{if(D.includes(e.type))return void a(e);const o=(e=>{const t=Object.keys($).includes(e.type)?"name":"id";let n="";const o="id"in e?"id":"name"in e?"name":void 0;return o||(n=e.type.toLowerCase()),o&&(n=e[o]),{value:n,key:t}})(e);if(o){Object.assign(e,{[o.key]:o.value});const{properties:t}=I[e.type];for(const n of Object.keys(t)){const t=n,a=e.type;if(i["*"].includes(t))continue;if(i[a]?.includes(t))continue;if(Object.keys(e).includes(n))continue;const r=n.replace(/-/g,"_");Object.assign(e,{[n]:`\${data.${o.value}.${r}}`})}n.push({identifier:o.value,type:e.type})}P(e,"id"),"form"===t&&(P(e,"error-message"),P(e,"init-value")),a(e)},a=e=>{for(const t of N)if(Array.isArray(e[t]))for(const n of e[t])o(n)};for(const t of e)o(t);return{parsedComponents:e,metadata:n}};function R(e){const{screens:t,...n}=e,o=[];for(const[e,n]of Object.entries(t)){const{type:t,components:a,...i}=n;let r=a;"form"===t&&(r=[{type:"Form",children:r}]);const{parsedComponents:s,metadata:l}=q(r,t),c=F(i.data,l);o.push({title:"${data.title.text}",...i,id:e,data:c,layout:{type:"SingleColumnLayout",children:s}})}return{...n,screens:o}}var A={};function L(e){return e}function J(e,t,n,o){return"screen"===e&&t&&n&&o?`\${${e}.${t}.${n}.${o}}`:`\${${e}.${t}}`}((e,t)=>{for(var n in t)a(e,n,{get:t[n],enumerable:!0})})(A,{complete:()=>G,components:()=>X,condition:()=>Q,dynamic_action:()=>M,dynamic_navigate:()=>U,dynamic_refresh:()=>Y,form_payload:()=>H,inline:()=>V,navigate:()=>B,parseUniqueId:()=>ee,screen:()=>L,state:()=>J,txt:()=>K,uniqueId:()=>Z,zod_payload:()=>W});var M={name:"data_exchange",payload:{}},B=(e,t={})=>({name:"navigate",next:{type:"screen",name:e},payload:t});function G(e={}){return{name:"complete",payload:e}}function U(e,t={}){return{name:"data_exchange",payload:{navigate:{screen:e,data:t}}}}var H=(...e)=>e.reduce(((e,t)=>(e[t]=`\${form.${t}}`,e)),{}),W=e=>Object.keys(e.shape).reduce(((e,t)=>(e[t]=`\${form.${t}}`,e)),{});function V(e){return"`"+e+"`"}function K(...e){return e.join("\n")}function Q(e){return V(e)}function X(e){return e}function Y(e={}){return{name:"data_exchange",payload:{refresh:e}}}var Z=e=>e+"?deduplicate="+Date.now(),ee=e=>{const t=e.split("?deduplicate=");return t.length>1?t[0]:e};function te(e){const t=(e,t)=>({navigate:{data:t??{},screen:e.toLowerCase()}}),n=t=>({data:t,screen:e.screen});return{...e,init:e=>n(e),navigate:t,first:e=>t(e),refresh:e=>n(e),error:e=>n({form:{error_messages:e}}),success:e=>({data:e??{},screen:"success"})}}function ne(e,t){const o=n.createWhatsapp();return"navigate"in e&&(e={data:e.navigate.data??{},screen:e.navigate.screen.toUpperCase()}),"screen"in e&&(e={data:e.data??{},screen:e.screen.toUpperCase()}),o.sdk.parsers.toGraph.flowResponse(t,e)}var oe=t.z.array(t.z.object({media_id:t.z.string(),cdn_url:t.z.string(),file_name:t.z.string(),encryption_metadata:t.z.object({encrypted_hash:t.z.string(),iv:t.z.string(),encryption_key:t.z.string(),hmac_key:t.z.string(),plaintext_hash:t.z.string()})}));exports.buildApiResponse=ne,exports.complete=G,exports.componentData=function(e){return Object.entries(e).reduce(((e,[t,n])=>(e[t.replaceAll("-","_")]=n,e)),{})},exports.components=X,exports.condition=Q,exports.createDevFlowJson=R,exports.createFlowContext=te,exports.createFlowControllerPool=function(e){return e.reduce(((e,t)=>(Object.assign(e,{[t.name]:t.screenHandlers}),e)),{})},exports.createNativeFlowJson=function(e){const{metadata:t,preview:n,id:o,...a}=e;return JSON.parse((e=>{let t=e;return t=(e=>e.replace(/^\s*"type":\s*"string",?\n(?=\s*"const":\s*"update_data")/gm,""))(t),t=(e=>e.replaceAll(/"(Then|Else|Cases)":/g,((e,t)=>`"${t.toLowerCase()}":`)))(t),t})(JSON.stringify(a,null,2)))},exports.createStoreFactory=function(e){return function(t,n={}){return{adapterFactory:e,schema:t,defaultValue:n}}},exports.deployFlows=async function(e,t){const a=n.createWhatsapp(),{data:i}=await a.sdk.actions.flows.getMany(),r=new Map(t.map((e=>[e.metadata.name,e]))),s=new Map(e.map((e=>[e.metadata.name,e]))),l=[],c=[];for(const[e,t]of r.entries()){const n=i.find((t=>t.name===e));if(!n){l.push(R(t));continue}const a=s.get(e);if(!a){c.push({id:n.id,flow:R(t)});continue}const{preview:r,metadata:p,...d}=a,{preview:u,metadata:m,...g}=t;o.isDeepStrictEqual(r,u)&&o.isDeepStrictEqual(d,g)?console.log(`Skipping '${e}', no changes`):c.push({id:n.id,flow:R(t)})}for(const e of l){const{id:t,metadata:n,preview:o,...i}=e,{name:r}=n;console.log(`Creating and publishing flow '${r}'`);try{await a.sdk.actions.flows.create({name:n.name,categories:n.categories,endpoint_uri:n.endpoint_uri,flow_json:JSON.stringify(i),publish:!0}),console.log(`\t✔ - Successfully created and published flow '${r}'`)}catch(e){throw console.error(`✖ - Error during creation/publishing of flow '${r}':`,e),new Error(`Deployment halted at flow '${r}'`)}}for(const{id:e,flow:t}of c){const{metadata:n,preview:o,...i}=t,{name:r,...s}=n;console.log(`Updating and publishing flow '${r}' (id: ${e})`);try{const t=await a.sdk.actions.flows.updateJson(e,i);if(t.validation_errors.length)throw console.error(`✖ - Error during JSON update of flow '${r}':`,t.validation_errors),new Error(`Deployment halted at flow '${r}'`);console.log("\t✔ - Successfully updated JSON"),await new Promise((e=>setTimeout(e,1e3))),await a.sdk.actions.flows.updateMetadata(e,s),console.log("\t✔ - Successfully updated metadata"),await a.sdk.actions.flows.publish(e),console.log("\t✔ - Successfully published")}catch(e){throw console.error(`✖ - Failed during update/publish of flow '${r}':`,e),new Error(`Deployment halted at flow '${r}'`)}}return[...c,...l]},exports.dispatchFlowPayload=async function(e,t){const o=((a=function(e){const t=n.createWhatsapp(),{screen:o,action:a,data:i,flow_token:r}=e,{flowName:s,flowIdentifier:l,flowParameters:c,chatId:p}=t.sdk.utils.flows.destructureFlowToken(r),d={action:"first",name:s,context:{chatId:p,screen:o,flow:s,identifier:l,parameters:c},data:i,screen:o};return"data_exchange"===a&&(d.action="submit",i.navigate&&(d.action="init",d.screen=i.navigate.screen,d.data=i.navigate.data),i.refresh&&(d.action="refresh",d.data=i.refresh)),"BACK"===a&&(d.action="back"),d}(t)).screen&&(a.screen=a.screen.toLowerCase()),a.context.screen&&(a.context.screen=a.context.screen.toLowerCase()),a);var a;let i={};if(i=o.screen?e?.[o.name]?.[o.screen]?.[o.action]:e?.[o.name]?.[o.action],!i)throw new Error(`No controller for action '${o.action}' in flow '${o.name}' for screen '${o.screen}'`);let r=await i({ctx:o.context,input:o.data,variables:o.data});if(!r)throw new Error(`No controller response for action '${o.action}' in flow '${o.name}' for screen '${o.screen}'`);if("navigate"in r){const t=r.navigate.screen,n=e[o.name][t];if(!n)throw new Error(`No screen controller for screen '${t}' in flow '${o.name}'`);const a=n.init;o.context.screen=t,r=await a({ctx:o.context,input:r.navigate.data})}return ne(r,t.flow_token)},exports.dynamic_action=M,exports.dynamic_navigate=U,exports.dynamic_refresh=Y,exports.f=A,exports.firstScreen=({define:e,store:t,middleware:n})=>async({ctx:o})=>{const a=te(o),i=t?.adapterFactory({flow_identifier:o.identifier,chat_id:o.chatId});let r={};if(i&&t){let e=await i.stash();0===Object.keys(e).length&&(e=t.defaultValue),r=new Proxy(e,{get:Reflect.get,set:Reflect.set})}const s={...a,store:r},l=n?await n(s):s;return e(l)},exports.flow=e=>e,exports.flowController=function(e,t){return{screenHandlers:t,name:e.name}},exports.flowMediaInput=oe,exports.form_payload=H,exports.getFlowMetadata=function(e){return{name:e.metadata.name,_typings_routing:null}},exports.getScreenMetadata=e=>null,exports.inline=V,exports.navigate=B,exports.parseUniqueId=ee,exports.screen=L,exports.screenController=function(e,t){const n=e=>async({ctx:n,input:o,variables:a})=>{const i=te(n);let r={};const s=t.store?.adapterFactory({flow_identifier:n.identifier,chat_id:n.chatId});if(t.store&&s){let e=await s.stash();0===Object.keys(e).length&&(e=t.store.defaultValue),r=new Proxy(e,{get:Reflect.get,set:Reflect.set})}const l={...i,store:r},c=t.middleware?await t.middleware(l):l;let p;if("init"===e){const e=t.actions?.init;if(!e)throw new Error(`No init handler for screen '${n.screen}' in flow '${n.flow}'`);const a=await e({ctx:c,data:o});p=c.init(a)}if("back"===e){const e=t.actions.back;if(!e)throw new Error(`No back handler for screen '${n.screen}' in flow '${n.flow}'`);p=await e({ctx:c})}if("refresh"===e){const e=t.actions.refresh;if(!e)throw new Error("Refresh handler is not defined");p=await e({ctx:c,variables:a})}if("submit"===e){const e=t.actions.submit;if(!e)throw new Error("Form submit handler is not defined");if(!t.input)throw new Error("Screen input schema is not defined");const n=t.input.safeParse(o);if(n.error){const e=n.error.errors.reduce(((e,t)=>(t.path?.[0]&&(e[t.path[0]]=t.message),e)),{});p=c.error(e)}else p=await e({ctx:c,input:n.data})}return s&&await s.flush(r),p};return{init:n("init"),refresh:n("refresh"),submit:n("submit"),back:n("back")}},exports.state=J,exports.txt=K,exports.uniqueId=Z,exports.zod_payload=W;