@ganju/utils 0.0.17 → 0.0.20

package/src/schema.ts

@@ -24,6 +24,18 @@ import {
   DATA_MAX_WRITE_OPERATIONS,
   DATA_ON_DELETE
 } from './dataTypes';
+import {
+  WHATSAPP_TEMPLATE_BODY_MAX,
+  WHATSAPP_TEMPLATE_BUTTON_MAX,
+  WHATSAPP_TEMPLATE_BUTTONS_MAX,
+  WHATSAPP_TEMPLATE_CATEGORIES,
+  WHATSAPP_TEMPLATE_EXAMPLE_MAX,
+  WHATSAPP_TEMPLATE_FOOTER_MAX,
+  WHATSAPP_TEMPLATE_HEADER_MAX,
+  WHATSAPP_TEMPLATE_LABEL_MAX,
+  WHATSAPP_TEMPLATE_NAME_MAX,
+  WHATSAPP_TEMPLATE_VARIABLES_MAX
+} from './whatsappTemplates';
 
 // A prompt title becomes a slash command; it must not collide with a command
 // the channel runner handles itself (e.g. `/link`).
@@ -767,12 +779,75 @@ const DATA_QUERY_RUN_BODY = z.strictObject({
   timeZone: z.string().max(100).optional()
 });
 
+// A trigger, as the dashboard, the API and ganju.json's "triggers" write it:
+// a table, an event, an optional condition and exactly one action. The
+// object checks the rest (columns, fields used in texts) against the schema.
+const DATA_TRIGGER_NAME = z
+  .string()
+  .regex(
+    /^[a-z][a-z0-9_-]{0,62}$/,
+    'Lowercase letters, digits, _ and -, starting with a letter'
+  );
+const DATA_TRIGGER_TEMPLATE = z.strictObject({
+  name: z.string().min(1).max(512),
+  language: z.string().min(1).max(20),
+  // Each {{n}} of the template in order: fixed text or a {{field}} of the row.
+  params: z.array(z.string().max(1024)).max(20).optional()
+});
+const DATA_TRIGGER_INPUT = z.strictObject({
+  name: DATA_TRIGGER_NAME.optional(),
+  description: z.string().max(300).nullish(),
+  table: DATA_IDENTIFIER,
+  on: z.enum(['insert', 'update', 'delete']),
+  // { column: { changedTo | changedFrom | equals: value, changed: true } },
+  // combined with { all: [...] } or { any: [...] }.
+  when: z.record(z.string(), z.unknown()).nullish(),
+  enabled: z.boolean().optional(),
+  // false: refuse to save over an existing trigger of this name.
+  replace: z.boolean().optional(),
+  // Runs a minute; past it events wait in the queue. 60 by default.
+  rateLimit: z.number().int().min(1).max(600).optional(),
+  function: z.string().min(1).max(64).optional(),
+  webhook: z.url().max(2000).optional(),
+  chat: z
+    .strictObject({
+      channelId: z.string().min(1).max(100),
+      chatId: z.union([z.string().min(1).max(200), z.number().int()]),
+      text: z.string().min(1).max(2000)
+    })
+    .optional(),
+  email: z
+    .strictObject({
+      to: z.union([z.email(), z.array(z.email()).min(1).max(10)]),
+      subject: z.string().min(1).max(200).optional(),
+      text: z.string().min(1).max(2000)
+    })
+    .optional(),
+  customer: z
+    .strictObject({
+      text: z.string().min(1).max(2000),
+      template: DATA_TRIGGER_TEMPLATE.optional()
+    })
+    .optional()
+});
+const DATA_TRIGGER_PATCH = z.strictObject({ enabled: z.boolean() });
+const DATA_TRIGGER_DEPLOY_BODY = z.strictObject({
+  triggers: z.array(DATA_TRIGGER_INPUT).max(50)
+});
+const DATA_TRIGGER_RUN_LIST_QUERY = z.object({
+  limit: z.coerce.number().int().min(1).max(50).optional()
+});
+
 const DATA_TABLE_PARAMS = DATA_DATABASE_GET.extend({ table: DATA_IDENTIFIER });
 const DATA_COLUMN_PARAMS = DATA_TABLE_PARAMS.extend({
   column: DATA_IDENTIFIER
 });
 const DATA_ROW_PARAMS = DATA_TABLE_PARAMS.extend({ id: DATA_ROW_ID });
 const DATA_QUERY_PATH_PARAMS = DATA_DATABASE_GET.extend({ name: DATA_IDENTIFIER });
+const DATA_TRIGGER_PATH_PARAMS = DATA_DATABASE_GET.extend({ name: DATA_TRIGGER_NAME });
+const DATA_TRIGGER_RUN_PARAMS = DATA_TRIGGER_PATH_PARAMS.extend({
+  runId: z.string().min(1).max(64)
+});
 
 const ARTIFACT_UPLOAD_RESOURCE_FILE = z.object({
   resourceId: z.uuid(),
@@ -1409,12 +1484,18 @@ const CUSTOM_CODE_TOOL = z.object({
   // is the owner's code. Narrowing matters most for a function a channel bot
   // calls after reading customer text, and the broker enforces it, since
   // anything in the script can be edited.
+  // false: deployed and run by triggers, but never offered to the assistant
+  // (left out of tools/list, and not counted toward its tools).
+  expose: z.boolean().optional(),
   data: z
     .strictObject({
       access: z.enum(['read', 'write']).optional(),
       tables: z.array(z.string().min(1).max(63)).max(50).optional()
     })
-    .optional()
+    .optional(),
+  // true: the function may message customers and chats through ctx.channels.
+  // Left out, the broker refuses it.
+  channels: z.boolean().optional()
 });
 
 // The manifest a `ganju deploy` (or the dashboard) uploads alongside a bundle.
@@ -1673,6 +1754,26 @@ const CUSTOM_CODE_BROKER_DATA = z.object({
   args: z.record(z.string(), z.unknown()).default({})
 });
 
+// ctx.channels: a message to a customer the bot has spoken with, or a post
+// to a chat the bot is in. `call` names the function, as for ctx.data.
+const CUSTOM_CODE_BROKER_CHANNELS_SEND = z.object({
+  call: z.string().min(1).max(4000),
+  participantId: z.string().min(1).max(100),
+  text: z.string().min(1).max(4000).optional(),
+  template: DATA_TRIGGER_TEMPLATE.optional()
+});
+// ctx.channels.templates: the approved WhatsApp templates of the project's
+// channels.
+const CUSTOM_CODE_BROKER_CHANNELS_TEMPLATES = z.object({
+  call: z.string().min(1).max(4000)
+});
+const CUSTOM_CODE_BROKER_CHANNELS_POST = z.object({
+  call: z.string().min(1).max(4000),
+  channelId: z.string().min(1).max(100),
+  chatId: z.union([z.string().min(1).max(200), z.number().int()]),
+  text: z.string().min(1).max(4000)
+});
+
 const CUSTOM_CODE_BROKER_RESOURCE_SEARCH = z.object({
   query: z.string().min(1).max(2000),
   limit: z.number().int().positive().max(20).default(5)
@@ -1916,6 +2017,60 @@ const CHANNEL_LIST_MESSAGES = z.object({
   organizationId: z.uuid()
 });
 
+const CHANNEL_WHATSAPP_PARAMS = z.object({
+  channelId: z.uuid(),
+  projectId: z.uuid(),
+  userId: z.uuid(),
+  organizationId: z.uuid()
+});
+
+// A new access token, the business account's id, or both, for a WhatsApp
+// channel's message templates. The rest of its credentials stay as they are.
+const CHANNEL_WHATSAPP_ACCOUNT = z
+  .strictObject({
+    accessToken: z.string().trim().min(20).max(2000).optional(),
+    businessAccountId: z
+      .string()
+      .trim()
+      .regex(/^\d{5,30}$/, 'The business account id is a number')
+      .optional()
+  })
+  .refine(
+    v => v.accessToken !== undefined || v.businessAccountId !== undefined,
+    'Give a new access token, the business account id, or both'
+  );
+
+// A WhatsApp message template as the dashboard writes it. Meta's own rules
+// are checked with checkWhatsappTemplate before it is sent for review.
+const CHANNEL_WHATSAPP_TEMPLATE_CONTENT = z.strictObject({
+  category: z.enum(WHATSAPP_TEMPLATE_CATEGORIES),
+  header: z.string().max(WHATSAPP_TEMPLATE_HEADER_MAX).nullish(),
+  body: z.string().trim().min(1).max(WHATSAPP_TEMPLATE_BODY_MAX),
+  footer: z.string().max(WHATSAPP_TEMPLATE_FOOTER_MAX).nullish(),
+  buttons: z
+    .array(z.string().max(WHATSAPP_TEMPLATE_BUTTON_MAX))
+    .max(WHATSAPP_TEMPLATE_BUTTONS_MAX)
+    .optional(),
+  // {{n}}'s example value and label are at n - 1.
+  examples: z
+    .array(z.string().max(WHATSAPP_TEMPLATE_EXAMPLE_MAX))
+    .max(WHATSAPP_TEMPLATE_VARIABLES_MAX)
+    .optional(),
+  labels: z
+    .array(z.string().max(WHATSAPP_TEMPLATE_LABEL_MAX))
+    .max(WHATSAPP_TEMPLATE_VARIABLES_MAX)
+    .optional()
+});
+const CHANNEL_WHATSAPP_TEMPLATE_CREATE = CHANNEL_WHATSAPP_TEMPLATE_CONTENT.extend(
+  {
+    name: z.string().trim().min(1).max(WHATSAPP_TEMPLATE_NAME_MAX),
+    language: z.string().trim().min(2).max(10)
+  }
+);
+const CHANNEL_WHATSAPP_TEMPLATE_PARAMS = CHANNEL_WHATSAPP_PARAMS.extend({
+  templateId: z.uuid()
+});
+
 const CHANNEL_CREATE_VIEW = CHANNEL_CREATE.omit({
   projectId: true,
   userId: true,
@@ -2038,6 +2193,12 @@ export const Schema = {
   DATA_QUERY_INPUT,
   DATA_QUERY_RUN_BODY,
   DATA_QUERY_PATH_PARAMS,
+  DATA_TRIGGER_INPUT,
+  DATA_TRIGGER_PATCH,
+  DATA_TRIGGER_DEPLOY_BODY,
+  DATA_TRIGGER_RUN_LIST_QUERY,
+  DATA_TRIGGER_PATH_PARAMS,
+  DATA_TRIGGER_RUN_PARAMS,
   DATA_COLUMN_PARAMS,
   DATA_ROW_PARAMS,
   ARTIFACT_REMOVE_RESOURCE,
@@ -2074,6 +2235,11 @@ export const Schema = {
   CHANNEL_REMOVE,
   CHANNEL_LIST_CONVERSATIONS,
   CHANNEL_LIST_MESSAGES,
+  CHANNEL_WHATSAPP_PARAMS,
+  CHANNEL_WHATSAPP_ACCOUNT,
+  CHANNEL_WHATSAPP_TEMPLATE_CREATE,
+  CHANNEL_WHATSAPP_TEMPLATE_CONTENT,
+  CHANNEL_WHATSAPP_TEMPLATE_PARAMS,
   ARTIFACT_UPDATE_RESOURCE_SHOW_SOURCE,
   ARTIFACT_UPDATE_RESOURCE_SYNC_INTERVAL,
   ARTIFACT_SYNC_RESOURCE,
@@ -2102,6 +2268,9 @@ export const Schema = {
   CUSTOM_CODE_BROKER_CONNECTION,
   CUSTOM_CODE_BROKER_SECRET,
   CUSTOM_CODE_BROKER_DATA,
+  CUSTOM_CODE_BROKER_CHANNELS_SEND,
+  CUSTOM_CODE_BROKER_CHANNELS_POST,
+  CUSTOM_CODE_BROKER_CHANNELS_TEMPLATES,
   CUSTOM_CODE_BROKER_RESOURCE_SEARCH,
   CUSTOM_CODE_BROKER_RESOURCE_READ,
   CUSTOM_CODE_BROKER_RESOURCE_CREATE,

package/src/sdkConstants.ts

@@ -30,6 +30,9 @@ export const CUSTOM_CODE_BROKER_PATH_RESOURCES_CREATE = '/resources/create';
 export const CUSTOM_CODE_BROKER_PATH_RESOURCES_DELETE = '/resources/delete';
 export const CUSTOM_CODE_BROKER_PATH_SEND_FILE = '/send-file';
 export const CUSTOM_CODE_BROKER_PATH_DATA = '/data';
+export const CUSTOM_CODE_BROKER_PATH_CHANNELS_SEND = '/channels/send';
+export const CUSTOM_CODE_BROKER_PATH_CHANNELS_POST = '/channels/post';
+export const CUSTOM_CODE_BROKER_PATH_CHANNELS_TEMPLATES = '/channels/templates';
 
 // Injected at upload time and echoed back by the health probe below. Uploading a
 // script into the dispatch namespace is not read-your-writes: dispatching to the