@budibase/types 3.12.6 → 3.12.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -64,11 +64,21 @@ export type DiscordStepInputs = {
64
64
  export type ExecuteQueryStepInputs = {
65
65
  query: {
66
66
  queryId: string;
67
+ [key: string]: any;
67
68
  };
68
69
  };
69
70
  export type ExecuteQueryStepOutputs = BaseAutomationOutputs & {
70
71
  info?: any;
71
72
  };
73
+ export type APIRequestStepInputs = {
74
+ query: {
75
+ queryId: string;
76
+ [key: string]: any;
77
+ };
78
+ };
79
+ export type APIRequestStepOutputs = BaseAutomationOutputs & {
80
+ info?: any;
81
+ };
72
82
  export type ExecuteScriptStepInputs = {
73
83
  code: string;
74
84
  };
@@ -120,12 +130,61 @@ export type OpenAIStepInputs = {
120
130
  prompt: string;
121
131
  model: Model;
122
132
  };
133
+ export type ClassifyContentStepInputs = {
134
+ inputType: string;
135
+ textInput: string;
136
+ categoryItems: Array<{
137
+ category: string;
138
+ }>;
139
+ };
140
+ export type ClassifyContentStepOutputs = {
141
+ category?: string;
142
+ success: boolean;
143
+ response?: string;
144
+ };
145
+ export type PromptLLMStepInputs = {
146
+ prompt: string;
147
+ model: Model;
148
+ };
149
+ export type PromptLLMStepOutputs = {
150
+ response?: string;
151
+ success: boolean;
152
+ };
153
+ export type TranslateStepInputs = {
154
+ text: string;
155
+ language: string;
156
+ };
157
+ export type TranslateStepOutputs = {
158
+ response?: string;
159
+ success: boolean;
160
+ };
161
+ export type SummariseStepInputs = {
162
+ text: string;
163
+ length?: SummariseLength;
164
+ };
165
+ export type SummariseStepOutputs = {
166
+ response?: string;
167
+ success: boolean;
168
+ };
169
+ export type GenerateTextStepInputs = {
170
+ contentType: string;
171
+ instructions: string;
172
+ };
173
+ export type GenerateTextStepOutputs = {
174
+ success: boolean;
175
+ response?: string;
176
+ };
123
177
  export declare enum Model {
124
178
  GPT_35_TURBO = "gpt-3.5-turbo",
125
179
  GPT_4 = "gpt-4",
126
180
  GPT_4O = "gpt-4o",
127
181
  GPT_4O_MINI = "gpt-4o-mini"
128
182
  }
183
+ export declare enum SummariseLength {
184
+ SHORT = "short",
185
+ MEDIUM = "medium",
186
+ LONG = "long"
187
+ }
129
188
  export type OpenAIStepOutputs = Omit<BaseAutomationOutputs, "response"> & {
130
189
  response?: string | null;
131
190
  };
@@ -36,7 +36,8 @@ export declare enum AutomationCustomIOType {
36
36
  AUTOMATION = "automation",
37
37
  AUTOMATION_FIELDS = "automationFields",
38
38
  MULTI_ATTACHMENTS = "multi_attachments",
39
- TRIGGER_FILTER = "trigger_filter"
39
+ TRIGGER_FILTER = "trigger_filter",
40
+ CATEGORIES = "categories"
40
41
  }
41
42
  export declare enum AutomationTriggerStepId {
42
43
  ROW_SAVED = "ROW_SAVED",
@@ -65,12 +66,18 @@ export declare enum AutomationActionStepId {
65
66
  SERVER_LOG = "SERVER_LOG",
66
67
  DELAY = "DELAY",
67
68
  FILTER = "FILTER",
69
+ API_REQUEST = "API_REQUEST",
68
70
  QUERY_ROWS = "QUERY_ROWS",
69
71
  LOOP = "LOOP",
70
72
  COLLECT = "COLLECT",
71
73
  OPENAI = "OPENAI",
72
74
  TRIGGER_AUTOMATION_RUN = "TRIGGER_AUTOMATION_RUN",
73
75
  BRANCH = "BRANCH",
76
+ CLASSIFY_CONTENT = "CLASSIFY_CONTENT",
77
+ PROMPT_LLM = "PROMPT_LLM",
78
+ TRANSLATE = "TRANSLATE",
79
+ SUMMARISE = "SUMMARISE",
80
+ GENERATE_TEXT = "GENERATE_TEXT",
74
81
  discord = "discord",
75
82
  slack = "slack",
76
83
  zapier = "zapier",
@@ -248,3 +255,21 @@ export declare enum LoopStepType {
248
255
  ARRAY = "Array",
249
256
  STRING = "String"
250
257
  }
258
+ export declare enum ContentType {
259
+ EMAIL = "email",
260
+ DOCUMENT = "document",
261
+ BLOG_POST = "blog_post",
262
+ CHAT_MESSAGE = "chat_message",
263
+ LETTER = "letter",
264
+ PROPOSAL = "proposal",
265
+ OTHER = "other"
266
+ }
267
+ export declare const PrettyContentTypes: {
268
+ email: string;
269
+ document: string;
270
+ blog_post: string;
271
+ chat_message: string;
272
+ letter: string;
273
+ proposal: string;
274
+ other: string;
275
+ };
@@ -1,12 +1,13 @@
1
1
  import { Hosting } from "../../../sdk";
2
2
  import { AutomationActionStepId, ActionImplementation, AutomationStepType, AutomationFeature, InputOutputBlock, AutomationTriggerStepId, AutomationEventType, AutomationIOType } from "./automation";
3
- import { CollectStepInputs, CollectStepOutputs, CreateRowStepInputs, CreateRowStepOutputs, DelayStepInputs, DelayStepOutputs, DeleteRowStepInputs, DeleteRowStepOutputs, ExecuteQueryStepInputs, ExecuteQueryStepOutputs, ExecuteScriptStepInputs, ExecuteScriptStepOutputs, FilterStepInputs, FilterStepOutputs, QueryRowsStepInputs, QueryRowsStepOutputs, SmtpEmailStepInputs, ServerLogStepInputs, ServerLogStepOutputs, TriggerAutomationStepInputs, TriggerAutomationStepOutputs, UpdateRowStepInputs, UpdateRowStepOutputs, OutgoingWebhookStepInputs, ExternalAppStepOutputs, DiscordStepInputs, SlackStepInputs, ZapierStepInputs, ZapierStepOutputs, MakeIntegrationInputs, n8nStepInputs, BashStepInputs, BashStepOutputs, OpenAIStepInputs, OpenAIStepOutputs, LoopStepInputs, CronTriggerInputs, RowUpdatedTriggerInputs, RowCreatedTriggerInputs, RowDeletedTriggerInputs, BranchStepInputs, BaseAutomationOutputs, AppActionTriggerOutputs, CronTriggerOutputs, RowDeletedTriggerOutputs, RowCreatedTriggerOutputs, RowUpdatedTriggerOutputs, WebhookTriggerOutputs, RowActionTriggerInputs } from "./StepInputsOutputs";
3
+ import { CollectStepInputs, CollectStepOutputs, CreateRowStepInputs, CreateRowStepOutputs, DelayStepInputs, DelayStepOutputs, DeleteRowStepInputs, DeleteRowStepOutputs, ExecuteQueryStepInputs, ExecuteQueryStepOutputs, ExecuteScriptStepInputs, ExecuteScriptStepOutputs, FilterStepInputs, FilterStepOutputs, QueryRowsStepInputs, QueryRowsStepOutputs, SmtpEmailStepInputs, ServerLogStepInputs, ServerLogStepOutputs, TriggerAutomationStepInputs, TriggerAutomationStepOutputs, UpdateRowStepInputs, UpdateRowStepOutputs, OutgoingWebhookStepInputs, ExternalAppStepOutputs, DiscordStepInputs, SlackStepInputs, ZapierStepInputs, ZapierStepOutputs, MakeIntegrationInputs, n8nStepInputs, BashStepInputs, BashStepOutputs, OpenAIStepInputs, OpenAIStepOutputs, LoopStepInputs, CronTriggerInputs, RowUpdatedTriggerInputs, RowCreatedTriggerInputs, RowDeletedTriggerInputs, BranchStepInputs, BaseAutomationOutputs, AppActionTriggerOutputs, CronTriggerOutputs, RowDeletedTriggerOutputs, RowCreatedTriggerOutputs, RowUpdatedTriggerOutputs, WebhookTriggerOutputs, RowActionTriggerInputs, ClassifyContentStepOutputs, ClassifyContentStepInputs, PromptLLMStepOutputs, PromptLLMStepInputs, TranslateStepOutputs, TranslateStepInputs, SummariseStepInputs, SummariseStepOutputs, GenerateTextStepInputs, GenerateTextStepOutputs, APIRequestStepInputs, APIRequestStepOutputs } from "./StepInputsOutputs";
4
4
  export type ActionImplementations<T extends Hosting> = {
5
5
  [AutomationActionStepId.COLLECT]: ActionImplementation<CollectStepInputs, CollectStepOutputs>;
6
6
  [AutomationActionStepId.CREATE_ROW]: ActionImplementation<CreateRowStepInputs, CreateRowStepOutputs>;
7
7
  [AutomationActionStepId.DELAY]: ActionImplementation<DelayStepInputs, DelayStepOutputs>;
8
8
  [AutomationActionStepId.DELETE_ROW]: ActionImplementation<DeleteRowStepInputs, DeleteRowStepOutputs>;
9
9
  [AutomationActionStepId.EXECUTE_QUERY]: ActionImplementation<ExecuteQueryStepInputs, ExecuteQueryStepOutputs>;
10
+ [AutomationActionStepId.API_REQUEST]: ActionImplementation<APIRequestStepInputs, APIRequestStepOutputs>;
10
11
  [AutomationActionStepId.EXECUTE_SCRIPT]: ActionImplementation<ExecuteScriptStepInputs, ExecuteScriptStepOutputs>;
11
12
  [AutomationActionStepId.EXECUTE_SCRIPT_V2]: ActionImplementation<ExecuteScriptStepInputs, ExecuteScriptStepOutputs>;
12
13
  [AutomationActionStepId.FILTER]: ActionImplementation<FilterStepInputs, FilterStepOutputs>;
@@ -22,6 +23,11 @@ export type ActionImplementations<T extends Hosting> = {
22
23
  [AutomationActionStepId.integromat]: ActionImplementation<MakeIntegrationInputs, ExternalAppStepOutputs>;
23
24
  [AutomationActionStepId.n8n]: ActionImplementation<n8nStepInputs, ExternalAppStepOutputs>;
24
25
  [AutomationActionStepId.OPENAI]: ActionImplementation<OpenAIStepInputs, OpenAIStepOutputs>;
26
+ [AutomationActionStepId.CLASSIFY_CONTENT]: ActionImplementation<ClassifyContentStepInputs, ClassifyContentStepOutputs>;
27
+ [AutomationActionStepId.PROMPT_LLM]: ActionImplementation<PromptLLMStepInputs, PromptLLMStepOutputs>;
28
+ [AutomationActionStepId.TRANSLATE]: ActionImplementation<TranslateStepInputs, TranslateStepOutputs>;
29
+ [AutomationActionStepId.SUMMARISE]: ActionImplementation<SummariseStepInputs, SummariseStepOutputs>;
30
+ [AutomationActionStepId.GENERATE_TEXT]: ActionImplementation<GenerateTextStepInputs, GenerateTextStepOutputs>;
25
31
  } & (T extends "self" ? {
26
32
  [AutomationActionStepId.EXECUTE_BASH]: ActionImplementation<BashStepInputs, BashStepOutputs>;
27
33
  } : {});
@@ -44,8 +50,8 @@ export interface AutomationStepSchemaBase {
44
50
  custom?: boolean;
45
51
  features?: Partial<Record<AutomationFeature, boolean>>;
46
52
  }
47
- export type AutomationStepInputs<T extends AutomationActionStepId> = T extends AutomationActionStepId.COLLECT ? CollectStepInputs : T extends AutomationActionStepId.CREATE_ROW ? CreateRowStepInputs : T extends AutomationActionStepId.DELAY ? DelayStepInputs : T extends AutomationActionStepId.DELETE_ROW ? DeleteRowStepInputs : T extends AutomationActionStepId.EXECUTE_QUERY ? ExecuteQueryStepInputs : T extends AutomationActionStepId.EXECUTE_SCRIPT ? ExecuteScriptStepInputs : T extends AutomationActionStepId.EXECUTE_SCRIPT_V2 ? ExecuteScriptStepInputs : T extends AutomationActionStepId.FILTER ? FilterStepInputs : T extends AutomationActionStepId.QUERY_ROWS ? QueryRowsStepInputs : T extends AutomationActionStepId.SEND_EMAIL_SMTP ? SmtpEmailStepInputs : T extends AutomationActionStepId.SERVER_LOG ? ServerLogStepInputs : T extends AutomationActionStepId.TRIGGER_AUTOMATION_RUN ? TriggerAutomationStepInputs : T extends AutomationActionStepId.UPDATE_ROW ? UpdateRowStepInputs : T extends AutomationActionStepId.OUTGOING_WEBHOOK ? OutgoingWebhookStepInputs : T extends AutomationActionStepId.discord ? DiscordStepInputs : T extends AutomationActionStepId.slack ? SlackStepInputs : T extends AutomationActionStepId.zapier ? ZapierStepInputs : T extends AutomationActionStepId.integromat ? MakeIntegrationInputs : T extends AutomationActionStepId.n8n ? n8nStepInputs : T extends AutomationActionStepId.EXECUTE_BASH ? BashStepInputs : T extends AutomationActionStepId.OPENAI ? OpenAIStepInputs : T extends AutomationActionStepId.LOOP ? LoopStepInputs : T extends AutomationActionStepId.BRANCH ? BranchStepInputs : never;
48
- export type AutomationStepOutputs<T extends AutomationActionStepId> = T extends AutomationActionStepId.COLLECT ? CollectStepOutputs : T extends AutomationActionStepId.CREATE_ROW ? CreateRowStepOutputs : T extends AutomationActionStepId.DELAY ? DelayStepOutputs : T extends AutomationActionStepId.DELETE_ROW ? DeleteRowStepOutputs : T extends AutomationActionStepId.EXECUTE_QUERY ? ExecuteQueryStepOutputs : T extends AutomationActionStepId.EXECUTE_SCRIPT ? ExecuteScriptStepOutputs : T extends AutomationActionStepId.FILTER ? FilterStepOutputs : T extends AutomationActionStepId.QUERY_ROWS ? QueryRowsStepOutputs : T extends AutomationActionStepId.SEND_EMAIL_SMTP ? BaseAutomationOutputs : T extends AutomationActionStepId.SERVER_LOG ? ServerLogStepOutputs : T extends AutomationActionStepId.TRIGGER_AUTOMATION_RUN ? TriggerAutomationStepOutputs : T extends AutomationActionStepId.UPDATE_ROW ? UpdateRowStepOutputs : T extends AutomationActionStepId.OUTGOING_WEBHOOK ? ExternalAppStepOutputs : T extends AutomationActionStepId.discord ? ExternalAppStepOutputs : T extends AutomationActionStepId.slack ? ExternalAppStepOutputs : T extends AutomationActionStepId.zapier ? ZapierStepOutputs : T extends AutomationActionStepId.integromat ? ExternalAppStepOutputs : T extends AutomationActionStepId.n8n ? ExternalAppStepOutputs : T extends AutomationActionStepId.EXECUTE_BASH ? BashStepOutputs : T extends AutomationActionStepId.OPENAI ? OpenAIStepOutputs : T extends AutomationActionStepId.LOOP ? BaseAutomationOutputs : never;
53
+ export type AutomationStepInputs<T extends AutomationActionStepId> = T extends AutomationActionStepId.COLLECT ? CollectStepInputs : T extends AutomationActionStepId.CREATE_ROW ? CreateRowStepInputs : T extends AutomationActionStepId.DELAY ? DelayStepInputs : T extends AutomationActionStepId.DELETE_ROW ? DeleteRowStepInputs : T extends AutomationActionStepId.EXECUTE_QUERY ? ExecuteQueryStepInputs : T extends AutomationActionStepId.API_REQUEST ? APIRequestStepInputs : T extends AutomationActionStepId.EXECUTE_SCRIPT ? ExecuteScriptStepInputs : T extends AutomationActionStepId.EXECUTE_SCRIPT_V2 ? ExecuteScriptStepInputs : T extends AutomationActionStepId.FILTER ? FilterStepInputs : T extends AutomationActionStepId.QUERY_ROWS ? QueryRowsStepInputs : T extends AutomationActionStepId.SEND_EMAIL_SMTP ? SmtpEmailStepInputs : T extends AutomationActionStepId.SERVER_LOG ? ServerLogStepInputs : T extends AutomationActionStepId.TRIGGER_AUTOMATION_RUN ? TriggerAutomationStepInputs : T extends AutomationActionStepId.UPDATE_ROW ? UpdateRowStepInputs : T extends AutomationActionStepId.OUTGOING_WEBHOOK ? OutgoingWebhookStepInputs : T extends AutomationActionStepId.discord ? DiscordStepInputs : T extends AutomationActionStepId.slack ? SlackStepInputs : T extends AutomationActionStepId.zapier ? ZapierStepInputs : T extends AutomationActionStepId.integromat ? MakeIntegrationInputs : T extends AutomationActionStepId.n8n ? n8nStepInputs : T extends AutomationActionStepId.EXECUTE_BASH ? BashStepInputs : T extends AutomationActionStepId.OPENAI ? OpenAIStepInputs : T extends AutomationActionStepId.LOOP ? LoopStepInputs : T extends AutomationActionStepId.BRANCH ? BranchStepInputs : T extends AutomationActionStepId.CLASSIFY_CONTENT ? ClassifyContentStepInputs : T extends AutomationActionStepId.PROMPT_LLM ? PromptLLMStepInputs : T extends AutomationActionStepId.TRANSLATE ? TranslateStepInputs : T extends AutomationActionStepId.SUMMARISE ? SummariseStepInputs : T extends AutomationActionStepId.GENERATE_TEXT ? GenerateTextStepInputs : never;
54
+ export type AutomationStepOutputs<T extends AutomationActionStepId> = T extends AutomationActionStepId.COLLECT ? CollectStepOutputs : T extends AutomationActionStepId.CREATE_ROW ? CreateRowStepOutputs : T extends AutomationActionStepId.DELAY ? DelayStepOutputs : T extends AutomationActionStepId.DELETE_ROW ? DeleteRowStepOutputs : T extends AutomationActionStepId.EXECUTE_QUERY ? ExecuteQueryStepOutputs : T extends AutomationActionStepId.API_REQUEST ? APIRequestStepOutputs : T extends AutomationActionStepId.EXECUTE_SCRIPT ? ExecuteScriptStepOutputs : T extends AutomationActionStepId.EXECUTE_SCRIPT_V2 ? ExecuteScriptStepOutputs : T extends AutomationActionStepId.FILTER ? FilterStepOutputs : T extends AutomationActionStepId.QUERY_ROWS ? QueryRowsStepOutputs : T extends AutomationActionStepId.SEND_EMAIL_SMTP ? BaseAutomationOutputs : T extends AutomationActionStepId.SERVER_LOG ? ServerLogStepOutputs : T extends AutomationActionStepId.TRIGGER_AUTOMATION_RUN ? TriggerAutomationStepOutputs : T extends AutomationActionStepId.UPDATE_ROW ? UpdateRowStepOutputs : T extends AutomationActionStepId.OUTGOING_WEBHOOK ? ExternalAppStepOutputs : T extends AutomationActionStepId.discord ? ExternalAppStepOutputs : T extends AutomationActionStepId.slack ? ExternalAppStepOutputs : T extends AutomationActionStepId.zapier ? ZapierStepOutputs : T extends AutomationActionStepId.integromat ? ExternalAppStepOutputs : T extends AutomationActionStepId.EXECUTE_BASH ? BashStepOutputs : T extends AutomationActionStepId.OPENAI ? OpenAIStepOutputs : T extends AutomationActionStepId.LOOP ? BaseAutomationOutputs : T extends AutomationActionStepId.CLASSIFY_CONTENT ? ClassifyContentStepOutputs : T extends AutomationActionStepId.PROMPT_LLM ? PromptLLMStepOutputs : T extends AutomationActionStepId.TRANSLATE ? TranslateStepOutputs : T extends AutomationActionStepId.SUMMARISE ? SummariseStepOutputs : T extends AutomationActionStepId.GENERATE_TEXT ? GenerateTextStepOutputs : never;
49
55
  export interface AutomationStepSchema<TStep extends AutomationActionStepId> extends AutomationStepSchemaBase {
50
56
  id: string;
51
57
  stepId: TStep;
@@ -56,6 +62,7 @@ export type CreateRowStep = AutomationStepSchema<AutomationActionStepId.CREATE_R
56
62
  export type DelayStep = AutomationStepSchema<AutomationActionStepId.DELAY>;
57
63
  export type DeleteRowStep = AutomationStepSchema<AutomationActionStepId.DELETE_ROW>;
58
64
  export type ExecuteQueryStep = AutomationStepSchema<AutomationActionStepId.EXECUTE_QUERY>;
65
+ export type APIRequestStep = AutomationStepSchema<AutomationActionStepId.API_REQUEST>;
59
66
  export type ExecuteScriptStep = AutomationStepSchema<AutomationActionStepId.EXECUTE_SCRIPT>;
60
67
  export type ExecuteScriptV2Step = AutomationStepSchema<AutomationActionStepId.EXECUTE_SCRIPT_V2>;
61
68
  export type FilterStep = AutomationStepSchema<AutomationActionStepId.FILTER>;
@@ -73,8 +80,13 @@ export type N8nStep = AutomationStepSchema<AutomationActionStepId.n8n>;
73
80
  export type ExecuteBashStep = AutomationStepSchema<AutomationActionStepId.EXECUTE_BASH>;
74
81
  export type OpenAIStep = AutomationStepSchema<AutomationActionStepId.OPENAI>;
75
82
  export type LoopStep = AutomationStepSchema<AutomationActionStepId.LOOP>;
83
+ export type ClassifyContentStep = AutomationStepSchema<AutomationActionStepId.CLASSIFY_CONTENT>;
84
+ export type PromptLLMStep = AutomationStepSchema<AutomationActionStepId.PROMPT_LLM>;
85
+ export type TranslateStep = AutomationStepSchema<AutomationActionStepId.TRANSLATE>;
86
+ export type SummariseStep = AutomationStepSchema<AutomationActionStepId.SUMMARISE>;
87
+ export type GenerateTextStep = AutomationStepSchema<AutomationActionStepId.GENERATE_TEXT>;
76
88
  export type BranchStep = AutomationStepSchema<AutomationActionStepId.BRANCH>;
77
- export type AutomationStep = CollectStep | CreateRowStep | DelayStep | DeleteRowStep | ExecuteQueryStep | ExecuteScriptStep | ExecuteScriptV2Step | FilterStep | QueryRowsStep | SendEmailSmtpStep | ServerLogStep | TriggerAutomationRunStep | UpdateRowStep | OutgoingWebhookStep | DiscordStep | SlackStep | ZapierStep | IntegromatStep | N8nStep | LoopStep | ExecuteBashStep | OpenAIStep | BranchStep;
89
+ export type AutomationStep = CollectStep | CreateRowStep | DelayStep | DeleteRowStep | ExecuteQueryStep | APIRequestStep | ExecuteScriptStep | ExecuteScriptV2Step | FilterStep | QueryRowsStep | SendEmailSmtpStep | ServerLogStep | TriggerAutomationRunStep | UpdateRowStep | OutgoingWebhookStep | DiscordStep | SlackStep | ZapierStep | IntegromatStep | N8nStep | LoopStep | ExecuteBashStep | OpenAIStep | BranchStep | ClassifyContentStep | PromptLLMStep | TranslateStep | SummariseStep | GenerateTextStep;
78
90
  export declare function isBranchStep(step: AutomationStep | AutomationTrigger): step is BranchStep;
79
91
  export declare function isTrigger(step: AutomationStep | AutomationTrigger): step is AutomationTrigger;
80
92
  export declare function isRowUpdateTrigger(step: AutomationStep | AutomationTrigger): step is RowUpdatedTrigger;