@budibase/types 3.2.24 → 3.2.26

package/dist/api/web/{application.d.ts → app/application.d.ts}

@@ -1,5 +1,5 @@
-import type { PlanType } from "../../sdk";
-import type { Layout, App, Screen } from "../../documents";
+import type { PlanType } from "../../../sdk";
+import type { Layout, App, Screen } from "../../../documents";
 import { ReadStream } from "fs";
 export interface SyncAppResponse {
     message: string;

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

@@ -1,7 +1,55 @@
-import { AutomationActionStepId, AutomationStepDefinition, AutomationTriggerDefinition, AutomationTriggerStepId } from "../../../documents";
+import { Automation, AutomationActionStepId, AutomationLogPage, AutomationStatus, AutomationStepDefinition, AutomationTriggerDefinition, AutomationTriggerStepId, Row } from "../../../documents";
+import { DocumentDestroyResponse } from "@budibase/nano";
 export type GetAutomationTriggerDefinitionsResponse = Record<keyof typeof AutomationTriggerStepId, AutomationTriggerDefinition>;
 export type GetAutomationActionDefinitionsResponse = Record<keyof typeof AutomationActionStepId, AutomationStepDefinition>;
 export interface GetAutomationStepDefinitionsResponse {
     trigger: GetAutomationTriggerDefinitionsResponse;
     action: GetAutomationActionDefinitionsResponse;
 }
+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 → app/deployment.d.ts}

@@ -1,4 +1,4 @@
-import { DeploymentDoc, DeploymentStatus } from "../../documents";
+import { DeploymentDoc, DeploymentStatus } from "../../../documents";
 export interface PublishAppResponse extends DeploymentDoc {
 }
 export interface DeploymentProgressResponse {

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

@@ -1,6 +1,5 @@
 export * from "./backup";
 export * from "./datasource";
-export * from "./row";
 export * from "./view";
 export * from "./rows";
 export * from "./table";
@@ -10,3 +9,13 @@ export * from "./user";
 export * from "./rowAction";
 export * from "./automation";
 export * from "./component";
+export * from "./integration";
+export * from "./metadata";
+export * from "./query";
+export * from "./screen";
+export * from "./application";
+export * from "./layout";
+export * from "./deployment";
+export * from "./role";
+export * from "./webhook";
+export * from "./static";

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

@@ -0,0 +1,3 @@
+import { Integration, SourceName } from "../../../sdk";
+export type FetchIntegrationsResponse = Record<SourceName, Integration | undefined>;
+export type FindIntegrationResponse = Integration;

package/dist/api/web/{layout.d.ts → app/layout.d.ts}

@@ -1,5 +1,8 @@
-import { Layout } from "../../documents";
+import { Layout } from "../../../documents";
 export interface SaveLayoutRequest extends Layout {
 }
 export interface SaveLayoutResponse extends Layout {
 }
+export interface DeleteLayoutResponse {
+    message: string;
+}

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

@@ -0,0 +1,13 @@
+import { MetadataType, Document } from "../../../documents";
+export interface GetMetadataTypesResponse {
+    types: typeof MetadataType;
+}
+export interface SaveMetadataRequest extends Document {
+}
+export interface SaveMetadataResponse extends Document {
+}
+export interface DeleteMetadataResponse {
+    message: string;
+}
+export interface FindMetadataResponse extends Document {
+}

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

@@ -1,4 +1,6 @@
-import { PermissionLevel } from "../../../sdk";
+import { BuiltinPermission, PermissionLevel } from "../../../sdk";
+export type FetchBuiltinPermissionsRequest = BuiltinPermission[];
+export type FetchPermissionLevelsRequest = string[];
 export interface FetchResourcePermissionInfoResponse {
     [key: string]: Record<string, string>;
 }

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

@@ -0,0 +1,44 @@
+import { Datasource, Query, QueryPreview, QuerySchema } from "../../../documents";
+export type FetchQueriesResponse = Query[];
+export interface SaveQueryRequest extends Query {
+}
+export interface SaveQueryResponse extends Query {
+}
+export interface ImportRestQueryRequest {
+    datasourceId: string;
+    data: string;
+    datasource: Datasource;
+}
+export interface ImportRestQueryResponse {
+    errorQueries: Query[];
+    queries: Query[];
+    datasourceId: string;
+}
+export interface FindQueryResponse extends Query {
+}
+export interface PreviewQueryRequest extends QueryPreview {
+}
+export interface PreviewQueryResponse {
+    rows: any[];
+    nestedSchemaFields: {
+        [key: string]: {
+            [key: string]: string | QuerySchema;
+        };
+    };
+    schema: {
+        [key: string]: string | QuerySchema;
+    };
+    info: any;
+    extra: any;
+}
+export interface ExecuteQueryRequest {
+    parameters?: Record<string, string>;
+    pagination?: any;
+}
+export type ExecuteV1QueryResponse = Record<string, any>[];
+export interface ExecuteV2QueryResponse {
+    data: Record<string, any>[];
+}
+export interface DeleteQueryResponse {
+    message: string;
+}

package/dist/api/web/{role.d.ts → app/role.d.ts}

@@ -1,5 +1,5 @@
-import { Role, RoleUIMetadata } from "../../documents";
-import { PermissionLevel, BuiltinPermissionID } from "../../sdk";
+import { Role, RoleUIMetadata } from "../../../documents";
+import { PermissionLevel, BuiltinPermissionID } from "../../../sdk";
 export interface SaveRoleRequest {
     _id?: string;
     _rev?: string;
@@ -15,7 +15,7 @@ export interface SaveRoleResponse extends Role {
 export interface FindRoleResponse extends Role {
 }
 export type FetchRolesResponse = Role[];
-export interface DestroyRoleResponse {
+export interface DeleteRoleResponse {
     message: string;
 }
 export type AccessibleRolesResponse = string[];

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

@@ -1,10 +1,16 @@
 import { SearchFilters } from "../../../../sdk";
 import { Row } from "../../../../documents";
-import { SortOrder } from "../../../../api/web/pagination";
+import { SortOrder } from "../../pagination";
 import { ReadStream } from "fs";
+import stream from "node:stream";
 export * from "./search";
+export interface FetchEnrichedRowResponse extends Row {
+}
+export type FetchRowsResponse = Row[];
 export interface SaveRowRequest extends Row {
 }
+export interface SaveRowResponse extends Row {
+}
 export interface PatchRowRequest extends Row {
     _id: string;
     _rev: string;
@@ -24,3 +30,19 @@ export interface ExportRowsRequest {
     };
 }
 export type ExportRowsResponse = ReadStream;
+export type DownloadAttachmentResponse = stream.PassThrough | stream.Readable;
+export interface FindRowResponse extends Row {
+}
+export interface DeleteRows {
+    rows: (Row | string)[];
+}
+export interface DeleteRow {
+    _id: string;
+}
+export type DeleteRowRequest = DeleteRows | DeleteRow;
+export interface ValidateRowRequest extends Row {
+}
+export interface ValidateRowResponse {
+    valid: boolean;
+    errors: Record<string, any>;
+}

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

@@ -0,0 +1,14 @@
+import { ScreenRoutingJson, Screen } from "../../../documents";
+export interface FetchScreenRoutingResponse {
+    routes: ScreenRoutingJson;
+}
+export interface FetchClientScreenRoutingResponse extends FetchScreenRoutingResponse {
+}
+export type FetchScreenResponse = Screen[];
+export interface SaveScreenRequest extends Screen {
+}
+export interface SaveScreenResponse extends Screen {
+}
+export interface DeleteScreenResponse {
+    message: string;
+}

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

@@ -0,0 +1,20 @@
+import { App } from "../../../documents";
+import stream from "node:stream";
+export interface ToggleBetaFeatureResponse {
+    message: string;
+}
+export type ServeAppResponse = string;
+interface BuilderPreview extends App {
+    builderPreview: boolean;
+}
+export type ServeBuilderPreviewResponse = BuilderPreview | string;
+export type ServeClientLibraryResponse = stream.Readable;
+export interface GetSignedUploadUrlRequest {
+    bucket: string;
+    key: string;
+}
+export interface GetSignedUploadUrlResponse {
+    signedUrl?: string;
+    publicUrl?: string;
+}
+export {};

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

@@ -3,10 +3,10 @@ import { ViewV2Enriched } from "../../../sdk";
 export type TableViewsResponse = {
     [key: string]: View | ViewV2Enriched;
 };
-export interface TableResponse extends Table {
+export interface FindTableResponse extends Table {
     views?: TableViewsResponse;
 }
-export type FetchTablesResponse = TableResponse[];
+export type FetchTablesResponse = FindTableResponse[];
 export interface SaveTableRequest extends TableRequest {
     rows?: Row[];
 }
@@ -18,11 +18,11 @@ export interface BulkImportRequest {
 export interface BulkImportResponse {
     message: string;
 }
-export interface MigrateRequest {
+export interface MigrateTableRequest {
     oldColumn: string;
     newColumn: string;
 }
-export interface MigrateResponse {
+export interface MigrateTableResponse {
     message: string;
 }
 export interface ValidateNewTableImportRequest {
@@ -45,3 +45,6 @@ export interface CsvToJsonRequest {
     csvString: string;
 }
 export type CsvToJsonResponse = any[];
+export interface DeleteTableResponse {
+    message: string;
+}

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

@@ -1,8 +1,25 @@
-import { ContextUserMetadata } from "../../../";
+import { ContextUserMetadata, Flags, UserMetadata } from "../../../";
+import { DocumentInsertResponse } from "@budibase/nano";
 export type FetchUserMetadataResponse = ContextUserMetadata[];
 export type FindUserMetadataResponse = ContextUserMetadata;
-export interface SetFlagRequest {
+export interface SetUserFlagRequest {
     flag: string;
     value: any;
 }
+export interface SetUserFlagResponse {
+    message: string;
+}
+export interface GetUserFlagsResponse extends Flags {
+}
 export type AppSelfResponse = ContextUserMetadata | {};
+export interface UpdateSelfMetadataRequest extends UserMetadata {
+}
+export interface UpdateSelfMetadataResponse extends DocumentInsertResponse {
+}
+export interface UpdateUserMetadataRequest extends UserMetadata {
+}
+export interface UpdateUserMetadataResponse extends DocumentInsertResponse {
+}
+export interface DeleteUserMetadataResponse {
+    message: string;
+}

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

@@ -11,5 +11,9 @@ export interface ViewFetchResponseEnriched {
 }
 export interface CreateViewRequest extends Omit<ViewV2, "version" | "id"> {
 }
+export interface CreateViewResponse extends ViewResponse {
+}
 export interface UpdateViewRequest extends ViewV2 {
 }
+export interface UpdateViewResponse extends ViewResponse {
+}

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

@@ -0,0 +1,20 @@
+import { Webhook } from "../../../documents";
+import { DocumentDestroyResponse, DocumentInsertResponse } from "@budibase/nano";
+export type FetchWebhooksResponse = Webhook[];
+export interface SaveWebhookRequest extends Webhook {
+}
+export interface SaveWebhookResponse {
+    message: string;
+    webhook: Webhook;
+}
+export interface DeleteWebhookResponse extends DocumentDestroyResponse {
+}
+export interface BuildWebhookSchemaRequest extends Record<string, any> {
+}
+export interface BuildWebhookSchemaResponse extends DocumentInsertResponse {
+}
+export interface TriggerWebhookRequest {
+}
+export type TriggerWebhookResponse = Record<string, any> | {
+    message: string;
+} | undefined;

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

@@ -2,13 +2,26 @@ export interface LoginRequest {
     username: string;
     password: string;
 }
+export interface LogoutResponse {
+    message: string;
+}
+export interface SetInitInfoRequest extends Record<string, any> {
+}
+export interface GetInitInfoResponse extends Record<string, any> {
+}
 export interface PasswordResetRequest {
     email: string;
 }
+export interface PasswordResetResponse {
+    message: string;
+}
 export interface PasswordResetUpdateRequest {
     resetCode: string;
     password: string;
 }
+export interface PasswordResetUpdateResponse {
+    message: string;
+}
 export interface UpdateSelfRequest {
     firstName?: string;
     lastName?: string;

package/dist/api/web/global/configs.d.ts

@@ -1,4 +1,4 @@
-import { SettingsConfig, SettingsInnerConfig } from "../../../documents";
+import { Config, ConfigType, SettingsBrandingConfig, SettingsConfig, SettingsInnerConfig } from "../../../documents";
 /**
  * Settings that aren't stored in the database - enriched at runtime.
  */
@@ -18,3 +18,31 @@ export interface PublicOIDCConfig {
     uuid?: string;
 }
 export type GetPublicOIDCConfigResponse = PublicOIDCConfig[];
+export interface SaveConfigRequest extends Config {
+}
+export interface SaveConfigResponse {
+    type: ConfigType;
+    _id: string;
+    _rev: string;
+}
+export interface DeleteConfigResponse {
+    message: string;
+}
+interface ChecklistItem {
+    checked: boolean;
+    label: string;
+    link: string;
+}
+export interface ConfigChecklistResponse {
+    apps: ChecklistItem;
+    smtp: ChecklistItem;
+    adminUser: ChecklistItem;
+    sso: ChecklistItem;
+    branding: SettingsBrandingConfig;
+}
+export type FindConfigResponse = Config | {};
+export interface UploadConfigFileResponse {
+    message: string;
+    url: string;
+}
+export {};

package/dist/api/web/global/email.d.ts

@@ -0,0 +1,26 @@
+import { EmailAttachment, EmailInvite } from "../../../documents";
+export declare enum EmailTemplatePurpose {
+    CORE = "core",
+    BASE = "base",
+    PASSWORD_RECOVERY = "password_recovery",
+    INVITATION = "invitation",
+    WELCOME = "welcome",
+    CUSTOM = "custom"
+}
+export interface SendEmailRequest {
+    workspaceId?: string;
+    email: string;
+    userId: string;
+    purpose: EmailTemplatePurpose;
+    contents?: string;
+    from?: string;
+    subject: string;
+    cc?: boolean;
+    bcc?: boolean;
+    automation?: boolean;
+    invite?: EmailInvite;
+    attachments?: EmailAttachment[];
+}
+export interface SendEmailResponse extends Record<string, any> {
+    message: string;
+}

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

@@ -4,3 +4,8 @@ export * from "./events";
 export * from "./configs";
 export * from "./scim";
 export * from "./license";
+export * from "./oldMigration";
+export * from "./email";
+export * from "./role";
+export * from "./self";
+export * from "./template";

package/dist/api/web/global/license.d.ts

@@ -1,3 +1,4 @@
+import { QuotaUsage } from "../../../documents";
 export interface ActivateLicenseKeyRequest {
     licenseKey: string;
 }
@@ -13,3 +14,5 @@ export interface GetOfflineLicenseTokenResponse {
 export interface GetOfflineIdentifierResponse {
     identifierBase64: string;
 }
+export interface GetQuotaUsageResponse extends QuotaUsage {
+}

package/dist/api/web/global/oldMigration.d.ts

@@ -0,0 +1,7 @@
+import { Migration, MigrationOptions } from "../../../sdk";
+export interface RunOldMigrationRequest extends MigrationOptions {
+}
+export type FetchOldMigrationResponse = Migration[];
+export interface GetOldMigrationStatus {
+    migrated: boolean;
+}

package/dist/api/web/global/role.d.ts

@@ -0,0 +1,15 @@
+import { Role } from "../../../documents";
+interface GlobalRoleResponse {
+    roles: Role[];
+    name: string;
+    version: string;
+    url?: string;
+}
+export interface FetchGlobalRolesResponse extends Record<string, GlobalRoleResponse> {
+}
+export interface FindGlobalRoleResponse extends GlobalRoleResponse {
+}
+export interface RemoveAppRoleResponse {
+    message: string;
+}
+export {};

package/dist/api/web/global/self.d.ts

@@ -0,0 +1,11 @@
+import { DevInfo, User } from "../../../documents";
+export interface GenerateAPIKeyRequest {
+    userId: string;
+}
+export interface GenerateAPIKeyResponse extends DevInfo {
+}
+export interface FetchAPIKeyResponse extends DevInfo {
+}
+export interface GetGlobalSelfResponse extends User {
+    flags?: Record<string, string>;
+}

package/dist/api/web/global/template.d.ts

@@ -0,0 +1,26 @@
+import { Template } from "../../../documents";
+export interface GlobalTemplateDefinition {
+    name: string;
+    description: string;
+    category: string;
+}
+export interface GlobalTemplateBinding {
+    name: string;
+    description: string;
+}
+export interface FetchGlobalTemplateDefinitionResponse {
+    info: Record<string, GlobalTemplateDefinition>;
+    bindings: Record<string, GlobalTemplateBinding[]>;
+}
+export interface SaveGlobalTemplateRequest extends Template {
+}
+export interface SaveGlobalTemplateResponse extends Template {
+}
+export type FetchGlobalTemplateResponse = Template[];
+export type FetchGlobalTemplateByTypeResponse = Template[];
+export type FetchGlobalTemplateByOwnerIDResponse = Template[];
+export interface FindGlobalTemplateResponse extends Template {
+}
+export interface DeleteGlobalTemplateResponse {
+    message: string;
+}

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

@@ -1,4 +1,3 @@
-export * from "./application";
 export * from "./analytics";
 export * from "./auth";
 export * from "./user";
@@ -11,11 +10,7 @@ export * from "./global";
 export * from "./pagination";
 export * from "./searchFilter";
 export * from "./cookies";
-export * from "./automation";
-export * from "./layout";
-export * from "./query";
-export * from "./role";
 export * from "./plugins";
 export * from "./apikeys";
-export * from "./deployment";
 export * from "./dev";
+export * from "./template";

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

@@ -1,4 +1,10 @@
-import { PluginSource } from "../../documents";
+import { PluginSource, Plugin } from "../../documents";
+export interface UploadPluginRequest {
+}
+export interface UploadPluginResponse {
+    message: string;
+    plugins: Plugin[];
+}
 export interface CreatePluginRequest {
     source: PluginSource;
     url: string;
@@ -10,3 +16,7 @@ export interface CreatePluginRequest {
 export interface CreatePluginResponse {
     plugin: any;
 }
+export type FetchPluginResponse = Plugin[];
+export interface DeletePluginResponse {
+    message: string;
+}

package/dist/api/web/system/account.d.ts

@@ -0,0 +1,5 @@
+import { Account, AccountMetadata } from "../../../documents";
+export interface SaveAccountRequest extends Account {
+}
+export interface SaveAccountResponse extends AccountMetadata {
+}

package/dist/api/web/system/environment.d.ts

@@ -1,8 +1,13 @@
 export interface GetEnvironmentResponse {
     multiTenancy: boolean;
+    offlineMode: boolean;
     cloud: boolean;
-    accountPortalUrl: string;
-    baseUrl: string;
+    accountPortalUrl?: string;
     disableAccountPortal: boolean;
+    baseUrl?: string;
     isDev: boolean;
+    maintenance: {
+        type: string;
+    }[];
+    passwordMinLength?: string;
 }

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

@@ -1,2 +1,8 @@
 export * from "./environment";
 export * from "./status";
+export * from "./ops";
+export * from "./account";
+export * from "./log";
+export * from "./migration";
+export * from "./restore";
+export * from "./tenant";

package/dist/api/web/system/log.d.ts

@@ -0,0 +1 @@
+export type GetLogResponse = Buffer;

package/dist/api/web/system/migration.d.ts

@@ -0,0 +1,4 @@
+import { MigrationDefinition, MigrationOptions } from "../../../sdk";
+export interface RunGlobalMigrationRequest extends MigrationOptions {
+}
+export type FetchMigrationDefinitionsResponse = MigrationDefinition[];

package/dist/api/web/system/ops.d.ts

@@ -0,0 +1,7 @@
+export interface LogOpsRequest {
+    message: string;
+    data?: any;
+}
+export interface ErrorOpsRequest {
+    message: string;
+}

package/dist/api/web/system/restore.d.ts

@@ -0,0 +1,3 @@
+export interface SystemRestoreResponse {
+    message: string;
+}

package/dist/api/web/system/tenant.d.ts

@@ -0,0 +1,3 @@
+export interface GetTenantInfoResponse {
+    exists: boolean;
+}

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

@@ -0,0 +1,18 @@
+export declare enum TemplateType {
+    APP = "app"
+}
+export interface TemplateMetadata {
+    background: string;
+    icon: string;
+    category: string;
+    description: string;
+    name: string;
+    url: string;
+    type: TemplateType;
+    key: string;
+    image: string;
+}
+export type FetchTemplateResponse = TemplateMetadata[];
+export interface DownloadTemplateResponse {
+    message: string;
+}