@budibase/types 3.2.18 → 3.2.20

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

@@ -2,6 +2,9 @@ export declare enum PingSource {
     BUILDER = "builder",
     APP = "app"
 }
+export interface AnalyticsEnabledResponse {
+    enabled: boolean;
+}
 export interface AnalyticsPingRequest {
     source: PingSource;
     timezone: string;

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

@@ -0,0 +1,8 @@
+export type ApiKeyFetchResponse = Record<string, string>;
+export interface UpdateApiKeyRequest {
+    value: string;
+}
+export interface UpdateApiKeyResponse {
+    _id: string;
+    _rev: string;
+}

package/dist/api/web/app/automation.d.ts

@@ -0,0 +1,7 @@
+import { AutomationActionStepId, AutomationStepDefinition, AutomationTriggerDefinition, AutomationTriggerStepId } from "../../../documents";
+export type GetAutomationTriggerDefinitionsResponse = Record<keyof typeof AutomationTriggerStepId, AutomationTriggerDefinition>;
+export type GetAutomationActionDefinitionsResponse = Record<keyof typeof AutomationActionStepId, AutomationStepDefinition>;
+export interface GetAutomationStepDefinitionsResponse {
+    trigger: GetAutomationTriggerDefinitionsResponse;
+    action: GetAutomationActionDefinitionsResponse;
+}

package/dist/api/web/app/component.d.ts

@@ -0,0 +1 @@
+export type FetchComponentDefinitionResponse = Record<string, Record<string, any>>;

package/dist/api/web/app/datasource.d.ts

@@ -33,3 +33,11 @@ export interface BuildSchemaFromSourceResponse {
     datasource: Datasource;
     errors: Record<string, string>;
 }
+export type FetchDatasourcesResponse = Datasource[];
+export type FindDatasourcesResponse = Datasource;
+export interface DeleteDatasourceResponse {
+    message: string;
+}
+export interface FetchExternalSchemaResponse {
+    schema: string;
+}

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

@@ -8,3 +8,5 @@ export * from "./permission";
 export * from "./attachment";
 export * from "./user";
 export * from "./rowAction";
+export * from "./automation";
+export * from "./component";

package/dist/api/web/app/user.d.ts

@@ -5,3 +5,4 @@ export interface SetFlagRequest {
     flag: string;
     value: any;
 }
+export type AppSelfResponse = ContextUserMetadata | {};

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

@@ -1,5 +1,9 @@
 import type { PlanType } from "../../sdk";
 import type { Layout, App, Screen } from "../../documents";
+import { ReadStream } from "fs";
+export interface SyncAppResponse {
+    message: string;
+}
 export interface CreateAppRequest {
     name: string;
     url?: string;
@@ -12,6 +16,8 @@ export interface CreateAppRequest {
         path: string;
     };
 }
+export interface CreateAppResponse extends App {
+}
 export interface DuplicateAppRequest {
     name: string;
     url?: string;
@@ -33,6 +39,7 @@ export interface FetchAppPackageResponse {
     clientLibPath: string;
     hasLock: boolean;
 }
+export type FetchAppsResponse = App[];
 export interface PublishResponse {
     _id: string;
     status: string;
@@ -42,3 +49,24 @@ export interface UpdateAppRequest extends Partial<App> {
 }
 export interface UpdateAppResponse extends App {
 }
+export interface UpdateAppClientResponse extends App {
+}
+export interface RevertAppClientResponse extends App {
+}
+export interface DeleteAppResponse {
+    ok: boolean;
+}
+export interface ImportToUpdateAppRequest {
+    encryptionPassword?: string;
+}
+export interface ImportToUpdateAppResponse {
+    message: string;
+}
+export interface SetRevertableAppVersionRequest {
+    revertableVersion: string;
+}
+export interface ExportAppDumpRequest {
+    excludeRows: boolean;
+    encryptPassword?: string;
+}
+export type ExportAppDumpResponse = ReadStream;

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

@@ -1,7 +1,49 @@
 import { DocumentDestroyResponse } from "@budibase/nano";
-import { Automation } from "../../documents";
+import { Automation, AutomationLogPage, AutomationStatus, Row } from "../../documents";
 export interface DeleteAutomationResponse extends DocumentDestroyResponse {
 }
 export interface FetchAutomationResponse {
     automations: Automation[];
 }
+export interface FindAutomationResponse extends Automation {
+}
+export interface UpdateAutomationRequest extends Automation {
+}
+export interface UpdateAutomationResponse {
+    message: string;
+    automation: Automation;
+}
+export interface CreateAutomationRequest extends Automation {
+}
+export interface CreateAutomationResponse {
+    message: string;
+    automation: Automation;
+}
+export interface SearchAutomationLogsRequest {
+    startDate?: string;
+    status?: AutomationStatus;
+    automationId?: string;
+    page?: string;
+}
+export interface SearchAutomationLogsResponse extends AutomationLogPage {
+}
+export interface ClearAutomationLogRequest {
+    automationId: string;
+    appId: string;
+}
+export interface ClearAutomationLogResponse {
+    message: string;
+}
+export interface TriggerAutomationRequest {
+    fields: Record<string, any>;
+    timeout: number;
+}
+export type TriggerAutomationResponse = Record<string, any> | undefined;
+export interface TestAutomationRequest {
+    id?: string;
+    revision?: string;
+    fields: Record<string, any>;
+    row?: Row;
+}
+export interface TestAutomationResponse {
+}

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

@@ -0,0 +1,10 @@
+import { DeploymentDoc, DeploymentStatus } from "../../documents";
+export interface PublishAppResponse extends DeploymentDoc {
+}
+export interface DeploymentProgressResponse {
+    _id: string;
+    appId: string;
+    status?: DeploymentStatus;
+    updatedAt: number;
+}
+export type FetchDeploymentResponse = DeploymentProgressResponse[];

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

@@ -0,0 +1,9 @@
+export interface GetVersionResponse {
+    version: string;
+}
+export interface ClearDevLockResponse {
+    message: string;
+}
+export interface RevertAppResponse {
+    message: string;
+}

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

@@ -16,3 +16,6 @@ export * from "./layout";
 export * from "./query";
 export * from "./role";
 export * from "./plugins";
+export * from "./apikeys";
+export * from "./deployment";
+export * from "./dev";

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

@@ -113,7 +113,7 @@ export type OpenAIStepInputs = {
     prompt: string;
     model: Model;
 };
-declare enum Model {
+export declare enum Model {
     GPT_35_TURBO = "gpt-3.5-turbo",
     GPT_4 = "gpt-4",
     GPT_4O = "gpt-4o",

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

@@ -99,7 +99,7 @@ export interface SendEmailOpts {
     invite?: EmailInvite;
     attachments?: EmailAttachment[];
 }
-export declare const AutomationStepIdArray: (AutomationActionStepId | AutomationTriggerStepId)[];
+export declare const AutomationStepIdArray: (AutomationTriggerStepId | AutomationActionStepId)[];
 export interface Automation extends Document {
     definition: {
         steps: AutomationStep[];

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

@@ -74,9 +74,11 @@ export type AutomationStep = CollectStep | CreateRowStep | DelayStep | DeleteRow
 type EmptyInputs = {};
 export type AutomationStepDefinition = Omit<AutomationStep, "id" | "inputs"> & {
     inputs: EmptyInputs;
+    deprecated?: boolean;
 };
 export type AutomationTriggerDefinition = Omit<AutomationTrigger, "id" | "inputs"> & {
     inputs: EmptyInputs;
+    deprecated?: boolean;
 };
 export type AutomationTriggerInputs<T extends AutomationTriggerStepId> = T extends AutomationTriggerStepId.APP ? AppActionTriggerInputs : T extends AutomationTriggerStepId.CRON ? CronTriggerInputs : T extends AutomationTriggerStepId.ROW_ACTION ? Record<string, any> : T extends AutomationTriggerStepId.ROW_DELETED ? RowDeletedTriggerInputs : T extends AutomationTriggerStepId.ROW_SAVED ? RowCreatedTriggerInputs : T extends AutomationTriggerStepId.ROW_UPDATED ? RowUpdatedTriggerInputs : T extends AutomationTriggerStepId.WEBHOOK ? Record<string, any> : never;
 export interface AutomationTriggerSchema<TTrigger extends AutomationTriggerStepId> extends AutomationStepSchemaBase {

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

@@ -0,0 +1,18 @@
+export declare enum DeploymentStatus {
+    SUCCESS = "SUCCESS",
+    PENDING = "PENDING",
+    FAILURE = "FAILURE"
+}
+export interface DeploymentDoc {
+    _id: string;
+    verification: any;
+    status?: DeploymentStatus;
+    history?: Record<string, {
+        _id: string;
+        appId: string;
+        status?: DeploymentStatus;
+        updatedAt: number;
+    }>;
+    err?: any;
+    appUrl?: string;
+}

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

@@ -18,3 +18,4 @@ export * from "./sqlite";
 export * from "./snippet";
 export * from "./rowAction";
 export * from "./theme";
+export * from "./deployment";

package/dist/documents/global/apikeys.d.ts

@@ -0,0 +1,4 @@
+import { Document } from "../../";
+export interface ApiKeyDoc extends Document {
+    apiKeys: Record<string, string>;
+}

package/dist/documents/global/index.d.ts

@@ -7,3 +7,4 @@ export * from "./schedule";
 export * from "./templates";
 export * from "./environmentVariables";
 export * from "./auditLogs";
+export * from "./apikeys";

package/dist/index.js

@@ -62,6 +62,7 @@ __export(src_exports, {
   DSPlusOperation: () => DSPlusOperation,
   DatasourceFeature: () => DatasourceFeature,
   DatasourceFieldType: () => DatasourceFieldType,
+  DeploymentStatus: () => DeploymentStatus,
   DocumentType: () => DocumentType,
   DocumentTypesToImport: () => DocumentTypesToImport,
   EmptyFilterOption: () => EmptyFilterOption,
@@ -93,6 +94,7 @@ __export(src_exports, {
   MaintenanceType: () => MaintenanceType,
   MigrationName: () => MigrationName,
   MigrationType: () => MigrationType,
+  Model: () => Model,
   MonthlyQuotaName: () => MonthlyQuotaName,
   NumericTypes: () => NumericTypes,
   Operation: () => Operation,
@@ -1060,6 +1062,15 @@ var LoopStepType = /* @__PURE__ */ ((LoopStepType2) => {
   return LoopStepType2;
 })(LoopStepType || {});
 
+// src/documents/app/automation/StepInputsOutputs.ts
+var Model = /* @__PURE__ */ ((Model2) => {
+  Model2["GPT_35_TURBO"] = "gpt-3.5-turbo";
+  Model2["GPT_4"] = "gpt-4";
+  Model2["GPT_4O"] = "gpt-4o";
+  Model2["GPT_4O_MINI"] = "gpt-4o-mini";
+  return Model2;
+})(Model || {});
+
 // src/documents/app/datasource.ts
 var RestAuthType = /* @__PURE__ */ ((RestAuthType2) => {
   RestAuthType2["BASIC"] = "basic";
@@ -1347,6 +1358,14 @@ var Theme = /* @__PURE__ */ ((Theme2) => {
   return Theme2;
 })(Theme || {});
 
+// src/documents/app/deployment.ts
+var DeploymentStatus = /* @__PURE__ */ ((DeploymentStatus2) => {
+  DeploymentStatus2["SUCCESS"] = "SUCCESS";
+  DeploymentStatus2["PENDING"] = "PENDING";
+  DeploymentStatus2["FAILURE"] = "FAILURE";
+  return DeploymentStatus2;
+})(DeploymentStatus || {});
+
 // src/documents/global/config.ts
 var isSettingsConfig = (config) => config.type === "settings" /* SETTINGS */;
 var isSMTPConfig = (config) => config.type === "smtp" /* SMTP */;
@@ -1586,6 +1605,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   DSPlusOperation,
   DatasourceFeature,
   DatasourceFieldType,
+  DeploymentStatus,
   DocumentType,
   DocumentTypesToImport,
   EmptyFilterOption,
@@ -1617,6 +1637,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   MaintenanceType,
   MigrationName,
   MigrationType,
+  Model,
   MonthlyQuotaName,
   NumericTypes,
   Operation,