@avakado.ai/schemas 1.1.27 → 1.1.29

package/enums.d.ts

@@ -1,3 +1,3 @@
 // Generated by scripts/emit-types.mjs. Run `npm run types` after a schema change.
 
-export { CAMPAIGN_STATUS, CONVERSATION_PRIORITY, CONVERSATION_STATUS, CURRENT_SUBSCRIPTION_STATUSES, LEDGER_CATEGORY, LEDGER_DIRECTIONS, LEDGER_SOURCE_TYPES, LEDGER_STATUSES, OAUTH_GRANT_MODES, PAYMENT_STATUS, PENDING_CHANGE_TYPES, SUBSCRIPTION_STATUS, TASK_REFERENCE_TYPES, TASK_STATUS, TASK_TYPES } from "./types.js";
+export { CAMPAIGN_STATUS, CONVERSATION_PRIORITY, CONVERSATION_STATUS, CURRENT_SUBSCRIPTION_STATUSES, EXOTEL_WEBHOOK_EVENTS, INSTAGRAM_WEBHOOK_EVENTS, LEDGER_CATEGORY, LEDGER_DIRECTIONS, LEDGER_SOURCE_TYPES, LEDGER_STATUSES, OAUTH_GRANT_MODES, PAYMENT_STATUS, PENDING_CHANGE_TYPES, SUBSCRIPTION_STATUS, TASK_REFERENCE_TYPES, TASK_STATUS, TASK_TYPES, TELEGRAM_WEBHOOK_EVENTS, WEBHOOK_TRIGGERS, WHATSAPP_CALL_EVENTS, WHATSAPP_CALL_STATUSES, WHATSAPP_MESSAGE_STATUSES, WORKFLOW_TRIGGERS } from "./types.js";

package/models.d.ts

@@ -1,3 +1,3 @@
 // Generated by scripts/emit-types.mjs. Run `npm run types` after a schema change.
 
-export { Action, AgentModel, AmountSchema, Api, ApiAuthenticationSchema, ApiAuthenticators, BillingLog, Business, BusinessSchema, CallSession, Campaign, CampaignSchema, Channel, ChannelCapabilityDefaults, Collection, Conversation, ConversationSchema, Data, DemonstrationModel, Lead, LeadTemplate, Log, Message, MessageSession, Notification, OAuthAuthorizationCode, OAuthClient, OAuthRefreshToken, OAuthRevokedJti, Payment, PaymentSchema, Plan, Providers, RoleScopes, ScopesEnum, Subscription, SubscriptionSchema, Task, TaskSchema, Template, Ticket, TriggerTemplate, UsageLog, UsageLogSchema, User, Workflow, WorkflowLogs } from "./types.js";
+export { Action, AgentModel, AmountSchema, Api, ApiAuthenticationSchema, ApiAuthenticators, BillingLog, Business, BusinessSchema, CallSession, Campaign, CampaignSchema, Channel, ChannelCapabilityDefaults, Collection, Conversation, ConversationSchema, CronJob, Data, DemonstrationModel, Lead, LeadTemplate, Log, Message, MessageSession, Notification, OAuthAuthorizationCode, OAuthClient, OAuthRefreshToken, OAuthRevokedJti, Payment, PaymentSchema, Plan, Providers, RoleScopes, ScopesEnum, Subscription, SubscriptionSchema, Task, TaskSchema, Template, Ticket, TriggerTemplate, UsageLog, UsageLogSchema, User, Workflow, WorkflowLogs } from "./types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avakado.ai/schemas",
-  "version": "1.1.27",
+  "version": "1.1.29",
   "description": "Canonical Mongo schemas, models, enums and index declarations shared by the Avakado services.",
   "license": "UNLICENSED",
   "type": "module",

package/src/enums/index.js

@@ -7,7 +7,34 @@ export const LEAD_STATUS = ["new", "contacted", "qualified", "converted", "lost"
 export const CONVERSATION_STATUS = ["open", "pending", "snoozed", "completed", "closed", "archived", "spam"];
 export const CAMPAIGN_STATUS = ["pending", "active", "completed", "failed", "partial"];
 export const TASK_STATUS = ["pending", "in-progress", "completed", "failed", "skipped"];
-export const WORKFLOW_TRIGGERS = [...LEAD_STATUS.map(status => `lead_${status}`), ...CONVERSATION_STATUS.map(status => `conversation_${status}`), ...CAMPAIGN_STATUS.map(status => `campaign_${status}`), ...TASK_STATUS.map(status => `task_${status}`)];
+
+// Webhook events the channel adapters publish. Names are `{channel}_{event}`.
+// Descriptions and sample payloads live on TriggerTemplate documents, not here.
+export const WHATSAPP_MESSAGE_STATUSES = ["sent", "delivered", "read", "played", "failed", "deleted"];
+export const WHATSAPP_CALL_EVENTS = ["connect", "terminate", "recording"];
+export const WHATSAPP_CALL_STATUSES = ["ringing", "accepted", "rejected", "completed", "failed"];
+export const INSTAGRAM_WEBHOOK_EVENTS = ["message", "postback", "read", "delivery", "reaction"];
+export const TELEGRAM_WEBHOOK_EVENTS = ["message", "message_edited", "callback"];
+export const EXOTEL_WEBHOOK_EVENTS = ["cancelled", "completed", "busy", "no_answer", "failed"];
+
+export const WEBHOOK_TRIGGERS = [
+    "whatsapp_message",
+    "whatsapp_reaction",
+    ...WHATSAPP_MESSAGE_STATUSES.map((status) => `whatsapp_message_${status}`),
+    ...WHATSAPP_CALL_EVENTS.map((event) => `whatsapp_call_${event}`),
+    ...WHATSAPP_CALL_STATUSES.map((status) => `whatsapp_call_${status}`),
+    ...INSTAGRAM_WEBHOOK_EVENTS.map((event) => `instagram_${event}`),
+    ...TELEGRAM_WEBHOOK_EVENTS.map((event) => `telegram_${event}`),
+    ...EXOTEL_WEBHOOK_EVENTS.map((event) => `exotel_${event}`),
+];
+
+export const WORKFLOW_TRIGGERS = [
+    ...LEAD_STATUS.map((status) => `lead_${status}`),
+    ...CONVERSATION_STATUS.map((status) => `conversation_${status}`),
+    ...CAMPAIGN_STATUS.map((status) => `campaign_${status}`),
+    ...TASK_STATUS.map((status) => `task_${status}`),
+    ...WEBHOOK_TRIGGERS,
+];
 export const CONVERSATION_PRIORITY = ["low", "normal", "high", "urgent"];
 export const SUBSCRIPTION_STATUS = [
     "created",

package/src/index.js

@@ -3,6 +3,7 @@ export * from "./models/index.js";
 export * from "./enums/index.js";
 export * from "./media.js";
 export { configureSchemas, defineModel, getSchemaConfig } from "./runtime.js";
+export { publishWorkflowTrigger, WORKFLOW_TRIGGER_TOPIC } from "./statusTrigger.js";
 export {
     CHAT_SESSION_MS,
     WHATSAPP_CALL_CALLBACK_MS,

package/src/models/CronJob.js

@@ -0,0 +1,26 @@
+import { Schema } from "mongoose";
+import { defineModel } from "../runtime.js";
+
+const CronJobSchema = new Schema({
+    _id: { type: String },
+    name: { type: String, required: true },
+    scheduleType: { type: String, enum: ["cron", "once"], default: "once" },
+    schedule: String,
+    runAt: Date,
+    type: { type: String, enum: ["shell", "http"], required: true },
+    command: String,
+    url: String,
+    method: { type: String, default: "GET" },
+    headers: String,
+    params: String,
+    body: String,
+    enabled: { type: Boolean, default: true },
+    lastRun: Date,
+    lastStatus: String,
+    miscIds: { type: Schema.Types.Mixed, default: () => ({}) },
+    createdAt: { type: Date, default: Date.now },
+});
+
+CronJobSchema.index({ scheduleType: 1, enabled: 1, runAt: 1 });
+
+export const CronJob = defineModel("CronJob", CronJobSchema, "CronJobs");

package/src/models/index.js

@@ -9,6 +9,7 @@ export { User, ScopesEnum, RoleScopes } from "./User.js";
 export { AgentModel } from "./Agent.js";
 export { Channel, ChannelCapabilityDefaults } from "./Channels.js";
 export { CallSession } from "./CallSessions.js";
+export { CronJob } from "./CronJob.js";
 export { Plan } from "./Plans.js";
 export { Api, Providers } from "./ExternalServiceProviders.js";
 export { Template } from "./market.js";

package/src/statusTrigger.js

@@ -1,5 +1,5 @@
 import { randomUUID } from "node:crypto";
-import { CAMPAIGN_STATUS, CONVERSATION_STATUS, LEAD_STATUS, TASK_STATUS } from "./enums/index.js";
+import { CAMPAIGN_STATUS, CONVERSATION_STATUS, LEAD_STATUS, TASK_STATUS, WORKFLOW_TRIGGERS } from "./enums/index.js";
 import { Workflow } from "./models/Workflow.js";
 import { requireDep } from "./runtime.js";
 
@@ -130,23 +130,55 @@ async function messagesForActiveWorkflows(messages) {
     return publishable;
 }
 
-async function publishStatusChanges(changes) {
-    const messages = await messagesForActiveWorkflows(changes.map(statusTriggerMessage).filter(Boolean));
-    if (!messages.length) return;
-    const sendKafkaMessage = requireDep("sendKafkaMessage", "workflow status trigger");
-    for (let i = 0; i < messages.length; i += BATCH_SIZE) {
-        const batch = messages.slice(i, i + BATCH_SIZE);
+async function publishTriggerMessages(messages) {
+    const publishable = await messagesForActiveWorkflows(messages);
+    if (!publishable.length) return;
+    const sendKafkaMessage = requireDep("sendKafkaMessage", "workflow trigger");
+    for (let i = 0; i < publishable.length; i += BATCH_SIZE) {
+        const batch = publishable.slice(i, i + BATCH_SIZE);
         try {
             await sendKafkaMessage({ topic: WORKFLOW_TRIGGER_TOPIC, messages: batch, acks: -1 });
         } catch (error) {
             console.error(
-                `@avakado.ai/schemas: failed to publish ${batch.length} workflow status trigger(s) on ${WORKFLOW_TRIGGER_TOPIC}`,
+                `@avakado.ai/schemas: failed to publish ${batch.length} workflow trigger(s) on ${WORKFLOW_TRIGGER_TOPIC}`,
                 error?.message || error
             );
         }
     }
 }
 
+async function publishStatusChanges(changes) {
+    await publishTriggerMessages(changes.map(statusTriggerMessage).filter(Boolean));
+}
+
+export async function publishWorkflowTrigger({ trigger, businessId, payload = {}, entity } = {}) {
+    if (typeof trigger !== "string" || !WORKFLOW_TRIGGERS.includes(trigger)) return;
+    const resolvedBusinessId = businessId == null || businessId === "" ? "" : String(businessId?._id ?? businessId);
+    if (!resolvedBusinessId) return;
+    let bodyPayload = {};
+    try {
+        bodyPayload = JSON.parse(JSON.stringify(payload ?? {}));
+    } catch {
+        bodyPayload = {};
+    }
+    const eventId = randomUUID();
+    await publishTriggerMessages([{
+        key: resolvedBusinessId,
+        value: JSON.stringify({
+            eventId,
+            businessId: resolvedBusinessId,
+            trigger,
+            payload: bodyPayload,
+        }),
+        headers: {
+            eventId,
+            businessId: resolvedBusinessId,
+            trigger,
+            entity: entity || trigger.split("_")[0],
+        },
+    }]);
+}
+
 function writeApplied(result) {
     if (result == null || typeof result !== "object") return false;
     if ("matchedCount" in result || "modifiedCount" in result || "upsertedCount" in result) {

package/types/models/CronJob.d.ts

@@ -0,0 +1,3 @@
+// Generated by scripts/emit-types.mjs. Run `npm run types` after a schema change.
+
+export { CronJob } from "../../types.js";

package/types.d.ts

@@ -235,6 +235,25 @@ export interface ConversationMethods {
     updateStatus(status?: any): Promise<any>;
 }
 
+export interface CronJob {
+    _id: string;
+    name: string;
+    scheduleType?: "cron" | "once";
+    schedule?: string;
+    runAt?: Date;
+    type: "shell" | "http";
+    command?: string;
+    url?: string;
+    method?: string;
+    headers?: string;
+    params?: string;
+    body?: string;
+    enabled?: boolean;
+    lastRun?: Date;
+    lastStatus?: string;
+    miscIds?: any;
+    createdAt?: Date;
+}
 
 export interface DemonstrationModel {
     transcripts?: any;
@@ -659,6 +678,8 @@ export const Collection: Model<Collection, {}, {}> & CollectionStatics;
 
 export const Conversation: Model<Conversation, {}, ConversationMethods>;
 
+export const CronJob: Model<CronJob, {}, {}>;
+
 export const DemonstrationModel: Model<DemonstrationModel, {}, {}>;
 
 export const Lead: Model<Lead, {}, {}>;
@@ -741,3 +762,23 @@ export const TASK_STATUS: readonly ["pending", "in-progress", "completed", "fail
 
 export const TASK_TYPES: readonly ["quick", "webhook"];
 
+export const WHATSAPP_MESSAGE_STATUSES: readonly ["sent", "delivered", "read", "played", "failed", "deleted"];
+
+export const WHATSAPP_CALL_EVENTS: readonly ["connect", "terminate", "recording"];
+
+export const WHATSAPP_CALL_STATUSES: readonly ["ringing", "accepted", "rejected", "completed", "failed"];
+
+export const INSTAGRAM_WEBHOOK_EVENTS: readonly ["message", "postback", "read", "delivery", "reaction"];
+
+export const TELEGRAM_WEBHOOK_EVENTS: readonly ["message", "message_edited", "callback"];
+
+export const EXOTEL_WEBHOOK_EVENTS: readonly ["cancelled", "completed", "busy", "no_answer", "failed"];
+
+export const WEBHOOK_TRIGGERS: readonly string[];
+
+export const WORKFLOW_TRIGGERS: readonly string[];
+
+export const WORKFLOW_TRIGGER_TOPIC: "workflow-execution-trigger";
+
+export function publishWorkflowTrigger(params?: { trigger?: string; businessId?: any; payload?: any; entity?: string }): Promise<void>;
+