@ganju/utils 0.0.16 → 0.0.18

package/src/schema.ts

@@ -707,6 +707,23 @@ const DATA_RESTORE_POINT_BODY = z.union([
   z.strictObject({ bookmark: z.string().min(1).max(200) })
 ]);
 
+// The database's own settings. `timeZone` is an IANA zone (America/Bogota),
+// or null for UTC: datetimes come back in it for callers that send none.
+const DATA_DATABASE_PATCH = z.strictObject({
+  timeZone: z
+    .string()
+    .max(100)
+    .refine(zone => {
+      try {
+        new Intl.DateTimeFormat('en-US', { timeZone: zone });
+        return true;
+      } catch {
+        return false;
+      }
+    }, 'Use an IANA time zone, such as America/Bogota.')
+    .nullable()
+});
+
 const DATA_EXPORT_BODY = z.strictObject({
   format: z.enum(['jsonl', 'csv']).optional()
 });
@@ -726,11 +743,99 @@ const DATA_CHANGE_LIST_QUERY = z.strictObject({
   cursor: z.uuid().optional()
 });
 
+// Named queries: a SELECT the owner writes once, with named parameters
+// (`:from`), checked to only read when it is saved.
+const DATA_QUERY_PARAM = z.strictObject({
+  name: DATA_IDENTIFIER,
+  type: z.enum(['text', 'integer', 'decimal', 'boolean', 'date', 'datetime']),
+  description: z.string().max(300).nullish(),
+  required: z.boolean().optional()
+});
+
+const DATA_QUERY_INPUT = z.strictObject({
+  name: DATA_IDENTIFIER,
+  description: z.string().max(300).nullish(),
+  sql: z.string().min(1).max(10_000),
+  params: z.array(DATA_QUERY_PARAM).max(20).optional(),
+  // Channel bots may run it from data-query.
+  assistant: z.boolean().optional()
+});
+
+const DATA_QUERY_RUN_BODY = z.strictObject({
+  params: z.record(z.string(), z.unknown()).optional(),
+  limit: z.number().int().min(1).max(500).optional(),
+  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(),
@@ -1362,7 +1467,20 @@ const CUSTOM_CODE_TOOL = z.object({
   description: z.string().max(2000).optional(),
   inputSchema: SCHEMA_DEFINITION.default({ type: 'object', properties: {} }),
   outputSchema: SCHEMA_DEFINITION.optional(),
-  annotations: TOOL_ANNOTATIONS.optional()
+  annotations: TOOL_ANNOTATIONS.optional(),
+  // What this function may do through ctx.data. Absent means everything: it
+  // 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()
 });
 
 // The manifest a `ganju deploy` (or the dashboard) uploads alongside a bundle.
@@ -1611,6 +1729,31 @@ const CUSTOM_CODE_BROKER_SECRET = z.object({
   name: z.string().min(1).max(200)
 });
 
+// One ctx.data call. `call` is the token the dispatcher signed for the
+// function being run, which the script hands back: the broker reads the
+// function's name from it, never from the script, and applies that
+// function's `data` narrowing.
+const CUSTOM_CODE_BROKER_DATA = z.object({
+  call: z.string().min(1).max(4000),
+  op: z.enum(['describe', 'query', 'write', 'run']),
+  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()
+});
+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)
@@ -1971,6 +2114,17 @@ export const Schema = {
   DATA_EXPORT_FILE_QUERY,
   DATA_CHANGE_LIST_QUERY,
   DATA_TABLE_PARAMS,
+  DATA_DATABASE_PATCH,
+  DATA_QUERY_PARAM,
+  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,
@@ -2034,6 +2188,9 @@ export const Schema = {
   CUSTOM_CODE_INVOKE_RESPONSE,
   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_RESOURCE_SEARCH,
   CUSTOM_CODE_BROKER_RESOURCE_READ,
   CUSTOM_CODE_BROKER_RESOURCE_CREATE,

package/src/sdkConstants.ts

@@ -29,6 +29,9 @@ export const CUSTOM_CODE_BROKER_PATH_RESOURCES_LIST = '/resources/list';
 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';
 
 // 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