@budibase/types 2.29.27 → 2.29.29

package/dist/api/web/index.d.ts

@@ -15,3 +15,4 @@ export * from "./automation";
 export * from "./layout";
 export * from "./query";
 export * from "./role";
+export * from "./plugins";

package/dist/api/web/plugins.d.ts

@@ -0,0 +1,12 @@
+import { PluginSource } from "../../documents";
+export interface CreatePluginRequest {
+    source: PluginSource;
+    url: string;
+    githubToken?: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export interface CreatePluginResponse {
+    plugin: any;
+}

package/dist/documents/app/{automation.d.ts → automation/automation.d.ts}

@@ -1,9 +1,9 @@
-import { Document } from "../document";
+import { Document } from "../../document";
 import { EventEmitter } from "events";
-import { User } from "../global";
+import { User } from "../../global";
 import { ReadStream } from "fs";
-import { Row } from "./row";
-import { Table } from "./table";
+import { Row } from "../row";
+import { Table } from "../table";
 export declare enum AutomationIOType {
     OBJECT = "object",
     STRING = "string",
@@ -84,11 +84,12 @@ export interface EmailAttachment {
     filename: string;
 }
 export interface SendEmailOpts {
+    to?: string;
     workspaceId?: string;
     user: User;
     from?: string;
     contents?: string;
-    subject?: string;
+    subject: string;
     info?: any;
     cc?: boolean;
     bcc?: boolean;
@@ -208,13 +209,15 @@ export interface AutomationLogPage {
     hasNextPage: boolean;
     nextPage?: string;
 }
-export type AutomationStepInput = {
-    inputs: Record<string, any>;
+export interface AutomationStepInputBase {
     context: Record<string, any>;
     emitter: EventEmitter;
     appId: string;
     apiKey?: string;
-};
+}
+export type ActionImplementation<TInputs, TOutputs> = (params: {
+    inputs: TInputs;
+} & AutomationStepInputBase) => Promise<TOutputs>;
 export interface AutomationMetadata extends Document {
     errorCount?: number;
     automationChainCount?: number;
@@ -246,4 +249,8 @@ export type UpdatedRowEventEmitter = {
     table: Table;
     appId: string;
 };
+export declare enum LoopStepType {
+    ARRAY = "Array",
+    STRING = "String"
+}
 export {};

package/dist/documents/app/automation/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./automation";
+export * from "./schema";

package/dist/documents/app/automation/schema.d.ts

@@ -0,0 +1,211 @@
+import { SortOrder } from "../../../api";
+import { EmptyFilterOption, Hosting, SearchFilters } from "../../../sdk";
+import { HttpMethod } from "../query";
+import { Row } from "../row";
+import { AutomationActionStepId, AutomationResults, EmailAttachment, LoopStepType, ActionImplementation } from "./automation";
+export type ActionImplementations<T extends Hosting> = {
+    [AutomationActionStepId.COLLECT]: ActionImplementation<CollectStepInputs, CollectStepOutputs>;
+    [AutomationActionStepId.CREATE_ROW]: ActionImplementation<CreateRowStepInputs, CreateRowStepOutputs>;
+    [AutomationActionStepId.DELAY]: ActionImplementation<DelayStepInputs, DelayStepOutputs>;
+    [AutomationActionStepId.DELETE_ROW]: ActionImplementation<DeleteRowStepInputs, DeleteRowStepOutputs>;
+    [AutomationActionStepId.EXECUTE_QUERY]: ActionImplementation<ExecuteQueryStepInputs, ExecuteQueryStepOutputs>;
+    [AutomationActionStepId.EXECUTE_SCRIPT]: ActionImplementation<ExecuteScriptStepInputs, ExecuteScriptStepOutputs>;
+    [AutomationActionStepId.FILTER]: ActionImplementation<FilterStepInputs, FilterStepOutputs>;
+    [AutomationActionStepId.QUERY_ROWS]: ActionImplementation<QueryRowsStepInputs, QueryRowsStepOutputs>;
+    [AutomationActionStepId.SEND_EMAIL_SMTP]: ActionImplementation<SmtpEmailStepInputs, BaseAutomationOutputs>;
+    [AutomationActionStepId.SERVER_LOG]: ActionImplementation<ServerLogStepInputs, ServerLogStepOutputs>;
+    [AutomationActionStepId.TRIGGER_AUTOMATION_RUN]: ActionImplementation<TriggerAutomationStepInputs, TriggerAutomationStepOutputs>;
+    [AutomationActionStepId.UPDATE_ROW]: ActionImplementation<UpdateRowStepInputs, UpdateRowStepOutputs>;
+    [AutomationActionStepId.OUTGOING_WEBHOOK]: ActionImplementation<OutgoingWebhookStepInputs, ExternalAppStepOutputs>;
+    [AutomationActionStepId.discord]: ActionImplementation<DiscordStepInputs, ExternalAppStepOutputs>;
+    [AutomationActionStepId.slack]: ActionImplementation<SlackStepInputs, ExternalAppStepOutputs>;
+    [AutomationActionStepId.zapier]: ActionImplementation<ZapierStepInputs, ZapierStepOutputs>;
+    [AutomationActionStepId.integromat]: ActionImplementation<MakeIntegrationInputs, ExternalAppStepOutputs>;
+    [AutomationActionStepId.n8n]: ActionImplementation<n8nStepInputs, ExternalAppStepOutputs>;
+} & (T extends "self" ? {
+    [AutomationActionStepId.EXECUTE_BASH]: ActionImplementation<BashStepInputs, BashStepOutputs>;
+    [AutomationActionStepId.OPENAI]: ActionImplementation<OpenAIStepInputs, OpenAIStepOutputs>;
+} : {});
+export type BaseAutomationOutputs = {
+    success?: boolean;
+    response?: {
+        [key: string]: any;
+        message?: string;
+    };
+};
+export type ExternalAppStepOutputs = {
+    httpStatus?: number;
+    response: string;
+    success: boolean;
+};
+export type BashStepInputs = {
+    code: string;
+};
+export type BashStepOutputs = BaseAutomationOutputs & {
+    stdout?: string;
+};
+export type CollectStepInputs = {
+    collection: string;
+};
+export type CollectStepOutputs = BaseAutomationOutputs & {
+    value?: any;
+};
+export type CreateRowStepInputs = {
+    row: Row;
+};
+export type CreateRowStepOutputs = BaseAutomationOutputs & {
+    row?: Row;
+    id?: string;
+    revision?: string;
+};
+export type DelayStepInputs = {
+    time: number;
+};
+export type DelayStepOutputs = BaseAutomationOutputs;
+export type DeleteRowStepInputs = {
+    tableId: string;
+    id: string;
+    revision?: string;
+};
+export type DeleteRowStepOutputs = BaseAutomationOutputs & {
+    row?: Row;
+};
+export type DiscordStepInputs = {
+    url: string;
+    username?: string;
+    avatar_url?: string;
+    content: string;
+};
+export type ExecuteQueryStepInputs = {
+    query: {
+        queryId: string;
+    };
+};
+export type ExecuteQueryStepOutputs = BaseAutomationOutputs & {
+    info?: any;
+};
+export type ExecuteScriptStepInputs = {
+    code: string;
+};
+export type ExecuteScriptStepOutputs = BaseAutomationOutputs & {
+    value?: string;
+};
+export type FilterStepInputs = {
+    field: any;
+    condition: string;
+    value: any;
+};
+export type FilterStepOutputs = BaseAutomationOutputs & {
+    result: boolean;
+    refValue?: any;
+    comparisonValue?: any;
+};
+export type LoopStepInputs = {
+    option: LoopStepType;
+    binding: any;
+    iterations?: number;
+    failure?: string;
+};
+export type LoopStepOutputs = {
+    items: string;
+    success: boolean;
+    iterations: number;
+};
+export type MakeIntegrationInputs = {
+    url: string;
+    body: any;
+};
+export type n8nStepInputs = {
+    url: string;
+    method: HttpMethod;
+    authorization: string;
+    body: any;
+};
+export type OpenAIStepInputs = {
+    prompt: string;
+    model: Model;
+};
+declare enum Model {
+    GPT_35_TURBO = "gpt-3.5-turbo",
+    GPT_4 = "gpt-4"
+}
+export type OpenAIStepOutputs = Omit<BaseAutomationOutputs, "response"> & {
+    response?: string | null;
+};
+export type QueryRowsStepInputs = {
+    tableId: string;
+    filters?: SearchFilters;
+    "filters-def"?: any;
+    sortColumn?: string;
+    sortOrder?: SortOrder;
+    limit?: number;
+    onEmptyFilter?: EmptyFilterOption;
+};
+export type QueryRowsStepOutputs = BaseAutomationOutputs & {
+    rows?: Row[];
+};
+export type SmtpEmailStepInputs = {
+    to: string;
+    from: string;
+    subject: string;
+    contents: string;
+    cc: string;
+    bcc: string;
+    addInvite?: boolean;
+    startTime: Date;
+    endTime: Date;
+    summary: string;
+    location?: string;
+    url?: string;
+    attachments?: EmailAttachment[];
+};
+export type ServerLogStepInputs = {
+    text: string;
+};
+export type ServerLogStepOutputs = BaseAutomationOutputs & {
+    message: string;
+};
+export type SlackStepInputs = {
+    url: string;
+    text: string;
+};
+export type TriggerAutomationStepInputs = {
+    automation: {
+        automationId: string;
+    };
+    timeout: number;
+};
+export type TriggerAutomationStepOutputs = BaseAutomationOutputs & {
+    value?: AutomationResults["steps"];
+};
+export type UpdateRowStepInputs = {
+    meta: Record<string, any>;
+    row: Row;
+    rowId: string;
+};
+export type UpdateRowStepOutputs = BaseAutomationOutputs & {
+    row?: Row;
+    id?: string;
+    revision?: string;
+};
+export type ZapierStepInputs = {
+    url: string;
+    body: any;
+};
+export type ZapierStepOutputs = Omit<ExternalAppStepOutputs, "response"> & {
+    response: string;
+};
+declare enum RequestType {
+    POST = "POST",
+    GET = "GET",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}
+export type OutgoingWebhookStepInputs = {
+    requestMethod: RequestType;
+    url: string;
+    requestBody: string;
+    headers: string;
+};
+export {};

package/dist/documents/app/datasource.d.ts

@@ -37,15 +37,15 @@ export interface DynamicVariable {
 }
 export interface RestConfig {
     url: string;
-    rejectUnauthorized: boolean;
+    rejectUnauthorized?: boolean;
     downloadImages?: boolean;
-    defaultHeaders: {
+    defaultHeaders?: {
         [key: string]: any;
     };
-    legacyHttpParser: boolean;
-    authConfigs: RestAuthConfig[];
-    staticVariables: {
+    legacyHttpParser?: boolean;
+    authConfigs?: RestAuthConfig[];
+    staticVariables?: {
         [key: string]: string;
     };
-    dynamicVariables: DynamicVariable[];
+    dynamicVariables?: DynamicVariable[];
 }

package/dist/documents/app/query.d.ts

@@ -29,33 +29,40 @@ export interface QueryResponse {
     extra: any;
     pagination: any;
 }
+export declare enum BodyType {
+    NONE = "none",
+    FORM_DATA = "form",
+    XML = "xml",
+    ENCODED = "encoded",
+    JSON = "json",
+    TEXT = "text"
+}
 export interface RestQueryFields {
-    path: string;
+    path?: string;
     queryString?: string;
-    headers: {
+    headers?: {
         [key: string]: any;
     };
-    disabledHeaders: {
+    disabledHeaders?: {
         [key: string]: any;
     };
-    requestBody: any;
-    bodyType: string;
-    json: object;
-    method: string;
-    authConfigId: string;
-    pagination: PaginationConfig | null;
-    paginationValues: PaginationValues | null;
+    requestBody?: any;
+    bodyType?: BodyType;
+    method?: string;
+    authConfigId?: string;
+    pagination?: PaginationConfig;
+    paginationValues?: PaginationValues;
 }
 export interface PaginationConfig {
     type: string;
     location: string;
     pageParam: string;
-    sizeParam: string | null;
-    responseParam: string | null;
+    sizeParam?: string;
+    responseParam?: string;
 }
 export interface PaginationValues {
-    page: string | number | null;
-    limit: number | null;
+    page?: string | number;
+    limit?: number;
 }
 export declare enum HttpMethod {
     GET = "GET",

package/dist/index.js

@@ -51,6 +51,7 @@ __export(src_exports, {
   BBReferenceFieldSubType: () => BBReferenceFieldSubType,
   BREAKDOWN_QUOTA_NAMES: () => BREAKDOWN_QUOTA_NAMES,
   BasicOperator: () => BasicOperator,
+  BodyType: () => BodyType,
   BreakdownQuotaName: () => BreakdownQuotaName,
   CommandWord: () => CommandWord,
   ConfigType: () => ConfigType,
@@ -81,6 +82,7 @@ __export(src_exports, {
   JsonTypes: () => JsonTypes,
   LockName: () => LockName,
   LockType: () => LockType,
+  LoopStepType: () => LoopStepType,
   MaintenanceType: () => MaintenanceType,
   MigrationName: () => MigrationName,
   MigrationType: () => MigrationType,
@@ -103,6 +105,7 @@ __export(src_exports, {
   RangeOperator: () => RangeOperator,
   RelationshipType: () => RelationshipType,
   RestAuthType: () => RestAuthType,
+  RowExportFormat: () => RowExportFormat,
   RowOperations: () => RowOperations,
   SEPARATOR: () => SEPARATOR,
   SQLiteType: () => SQLiteType,
@@ -819,6 +822,14 @@ var PermissionSource = /* @__PURE__ */ ((PermissionSource2) => {
   return PermissionSource2;
 })(PermissionSource || {});
 
+// src/sdk/row.ts
+var RowExportFormat = /* @__PURE__ */ ((RowExportFormat2) => {
+  RowExportFormat2["CSV"] = "csv";
+  RowExportFormat2["JSON"] = "json";
+  RowExportFormat2["JSON_WITH_SCHEMA"] = "jsonWithSchema";
+  return RowExportFormat2;
+})(RowExportFormat || {});
+
 // src/documents/account/account.ts
 var isCreatePasswordAccount = (account) => account.authType === "password" /* PASSWORD */;
 var isPasswordAccount = (account) => account.authType === "password" /* PASSWORD */ && account.hosting === "self" /* SELF */;
@@ -847,7 +858,7 @@ var AuthType = /* @__PURE__ */ ((AuthType2) => {
   return AuthType2;
 })(AuthType || {});
 
-// src/documents/app/automation.ts
+// src/documents/app/automation/automation.ts
 var AutomationIOType = /* @__PURE__ */ ((AutomationIOType2) => {
   AutomationIOType2["OBJECT"] = "object";
   AutomationIOType2["STRING"] = "string";
@@ -954,6 +965,11 @@ var AutomationEventType = /* @__PURE__ */ ((AutomationEventType2) => {
   AutomationEventType2["ROW_ACTION"] = "row:action";
   return AutomationEventType2;
 })(AutomationEventType || {});
+var LoopStepType = /* @__PURE__ */ ((LoopStepType2) => {
+  LoopStepType2["ARRAY"] = "Array";
+  LoopStepType2["STRING"] = "String";
+  return LoopStepType2;
+})(LoopStepType || {});
 
 // src/documents/app/datasource.ts
 var RestAuthType = /* @__PURE__ */ ((RestAuthType2) => {
@@ -963,6 +979,15 @@ var RestAuthType = /* @__PURE__ */ ((RestAuthType2) => {
 })(RestAuthType || {});
 
 // src/documents/app/query.ts
+var BodyType = /* @__PURE__ */ ((BodyType2) => {
+  BodyType2["NONE"] = "none";
+  BodyType2["FORM_DATA"] = "form";
+  BodyType2["XML"] = "xml";
+  BodyType2["ENCODED"] = "encoded";
+  BodyType2["JSON"] = "json";
+  BodyType2["TEXT"] = "text";
+  return BodyType2;
+})(BodyType || {});
 var HttpMethod = /* @__PURE__ */ ((HttpMethod2) => {
   HttpMethod2["GET"] = "GET";
   HttpMethod2["POST"] = "POST";
@@ -1335,6 +1360,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   BBReferenceFieldSubType,
   BREAKDOWN_QUOTA_NAMES,
   BasicOperator,
+  BodyType,
   BreakdownQuotaName,
   CommandWord,
   ConfigType,
@@ -1365,6 +1391,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   JsonTypes,
   LockName,
   LockType,
+  LoopStepType,
   MaintenanceType,
   MigrationName,
   MigrationType,
@@ -1387,6 +1414,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   RangeOperator,
   RelationshipType,
   RestAuthType,
+  RowExportFormat,
   RowOperations,
   SEPARATOR,
   SQLiteType,