@budibase/types 3.18.10 → 3.18.12

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

@@ -4,5 +4,5 @@ export interface GetVersionResponse {
 export interface ClearDevLockResponse {
     message: string;
 }
-export interface RevertAppResponse {
+export interface RevertWorkspaceResponse {
 }

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

@@ -9,7 +9,7 @@ export interface FetchGlobalRolesResponse extends Record<string, GlobalRoleRespo
 }
 export interface FindGlobalRoleResponse extends GlobalRoleResponse {
 }
-export interface RemoveAppRoleResponse {
+export interface RemoveWorkspaceRoleResponse {
     message: string;
 }
 export {};

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

@@ -1,17 +1,17 @@
 export * from "./ai";
 export * from "./analytics";
+export * from "./apikeys";
 export * from "./auth";
-export * from "./user";
-export * from "./errors";
+export * from "./cookies";
 export * from "./debug";
-export * from "./schedule";
-export * from "./system";
-export * from "./app";
+export * from "./dev";
+export * from "./errors";
 export * from "./global";
 export * from "./pagination";
-export * from "./searchFilter";
-export * from "./cookies";
 export * from "./plugins";
-export * from "./apikeys";
-export * from "./dev";
+export * from "./schedule";
+export * from "./searchFilter";
+export * from "./system";
 export * from "./template";
+export * from "./user";
+export * from "./workspace";

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

@@ -1,5 +1,5 @@
 export declare enum TemplateType {
-    APP = "app"
+    WORKSPACE = "app"
 }
 export interface TemplateMetadata {
     background: string;

package/dist/api/web/workspace/backup.d.ts

@@ -0,0 +1,46 @@
+import { BackupTrigger, BackupType } from "../../../documents";
+export interface SearchWorkspaceBackupsRequest {
+    trigger: BackupTrigger;
+    type: BackupType;
+    startDate: string;
+    endDate: string;
+    page?: string;
+}
+export interface CreateWorkspaceBackupRequest {
+    name: string;
+}
+export interface CreateWorkspaceBackupResponse {
+    backupId: string;
+    message: string;
+}
+export interface UpdateWorkspaceBackupRequest {
+    name: string;
+}
+export interface ImportWorkspaceBackupRequest {
+    name: string;
+}
+export interface ImportWorkspaceBackupResponse {
+    restoreId: string;
+    message: string;
+}
+export interface ClearBackupErrorRequest {
+    appId: string;
+    backupId?: string;
+}
+export interface ClearBackupErrorResponse {
+    message: string;
+}
+export interface DeleteWorkspaceBackupResult {
+    backupId: string;
+    success: boolean;
+    error?: string;
+}
+export interface DeleteWorkspaceBackupsRequest {
+    backupIds: string[];
+}
+export interface DeleteWorkspaceBackupsResponse {
+    message: string;
+    results: DeleteWorkspaceBackupResult[];
+    successCount: number;
+    failureCount: number;
+}

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

@@ -1,10 +1,10 @@
 import { DeploymentDoc, DeploymentStatus } from "../../../documents";
-export interface PublishAppRequest {
+export interface PublishWorkspaceRequest {
     automationIds?: string[];
     workspaceAppIds?: string[];
     seedProductionTables?: boolean;
 }
-export interface PublishAppResponse extends DeploymentDoc {
+export interface PublishWorkspaceResponse extends DeploymentDoc {
 }
 export declare enum PublishResourceState {
     PUBLISHED = "published",

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

@@ -1,4 +1,3 @@
-export * from "./application";
 export * from "./attachment";
 export * from "./automation";
 export * from "./backup";
@@ -9,10 +8,12 @@ export * from "./features";
 export * from "./integration";
 export * from "./layout";
 export * from "./metadata";
+export * from "./navigation";
 export * from "./oauth2";
 export * from "./permission";
-export * from "./workspaceApp";
 export * from "./query";
+export * from "./recaptcha";
+export * from "./resource";
 export * from "./role";
 export * from "./rowAction";
 export * from "./rows";
@@ -22,7 +23,6 @@ export * from "./table";
 export * from "./user";
 export * from "./view";
 export * from "./webhook";
-export * from "./navigation";
-export * from "./resource";
+export * from "./workspace";
+export * from "./workspaceApp";
 export * from "./workspaceFavourites";
-export * from "./recaptcha";

package/dist/api/web/{app → workspace}/rows/search.d.ts

@@ -1,7 +1,7 @@
-import { EmptyFilterOption } from "../../../../sdk";
-import { Row } from "../../../../documents";
-import { PaginationResponse, SortOrder, SortType } from "../../../../api/web/pagination";
 import { z } from "zod";
+import { Row } from "../../../../documents";
+import { EmptyFilterOption } from "../../../../sdk";
+import { PaginationResponse, SortOrder, SortType } from "../../pagination";
 declare const searchRowRequest: z.ZodObject<{
     query: z.ZodOptional<z.ZodObject<{
         equal: z.ZodTypeAny;

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

@@ -1,5 +1,5 @@
-import { ContextUserMetadata, Flags, UserMetadata } from "../../../";
 import { DocumentInsertResponse } from "@budibase/nano";
+import { ContextUserMetadata, Flags, UserMetadata } from "../../..";
 export type FetchUserMetadataResponse = ContextUserMetadata[];
 export type FindUserMetadataResponse = ContextUserMetadata;
 export interface SetUserFlagRequest {
@@ -11,7 +11,7 @@ export interface SetUserFlagResponse {
 }
 export interface GetUserFlagsResponse extends Flags {
 }
-export type AppSelfResponse = ContextUserMetadata | {};
+export type SelfResponse = ContextUserMetadata | {};
 export interface UpdateSelfMetadataRequest extends UserMetadata {
 }
 export interface UpdateSelfMetadataResponse extends DocumentInsertResponse {

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

@@ -1,10 +1,10 @@
 import { ReadStream } from "fs";
 import type { Layout, Screen, Workspace } from "../../../documents";
 import type { PlanType } from "../../../sdk";
-export interface SyncAppResponse {
+export interface SyncWorkspaceResponse {
     message: string;
 }
-export interface CreateAppRequest {
+export interface CreateWorkspaceRequest {
     name: string;
     url?: string;
     useTemplate?: string | boolean;
@@ -17,13 +17,13 @@ export interface CreateAppRequest {
     };
     isOnboarding?: string;
 }
-export interface CreateAppResponse extends Workspace {
+export interface CreateWorkspaceResponse extends Workspace {
 }
-export interface DuplicateAppRequest {
+export interface DuplicateWorkspaceRequest {
     name: string;
     url?: string;
 }
-export interface DuplicateAppResponse {
+export interface DuplicateWorkspaceResponse {
     duplicateAppId: string;
     sourceAppId: string;
 }
@@ -41,13 +41,13 @@ export interface FetchAppPackageResponse {
     hasLock: boolean;
     recaptchaKey?: string;
 }
-export interface AddAppSampleDataResponse {
+export interface AddWorkspaceSampleDataResponse {
     message: string;
 }
-export type FetchAppsResponse = (Workspace & {
+export type FetchWorkspacesResponse = (Workspace & {
     defaultWorkspaceAppUrl: string;
 })[];
-export interface PublishedAppData {
+export interface PublishedWorkspaceData {
     name: string;
     appId: string;
     url: string;
@@ -55,30 +55,30 @@ export interface PublishedAppData {
     updatedAt?: string;
 }
 export interface FetchPublishedAppsResponse {
-    apps: PublishedAppData[];
+    apps: PublishedWorkspaceData[];
 }
-export interface UpdateAppRequest extends Partial<Workspace> {
+export interface UpdateWorkspaceRequest extends Partial<Workspace> {
 }
-export interface UpdateAppResponse extends Workspace {
+export interface UpdateWorkspaceResponse extends Workspace {
 }
 export interface UpdateAppClientResponse extends Workspace {
 }
 export interface RevertAppClientResponse extends Workspace {
 }
-export interface DeleteAppResponse {
+export interface DeleteWorkspaceResponse {
     ok: boolean;
 }
-export interface UnpublishAppResponse {
+export interface UnpublishWorkspaceResponse {
     message: string;
 }
-export interface ImportToUpdateAppRequest {
+export interface ImportToUpdateWorkspaceRequest {
     encryptionPassword?: string;
 }
-export interface ImportToUpdateAppResponse {
+export interface ImportToUpdateWorkspaceResponse {
     message: string;
 }
-export interface ExportAppDumpRequest {
+export interface ExportWorkspaceDumpRequest {
     excludeRows: boolean;
     encryptPassword?: string;
 }
-export type ExportAppDumpResponse = ReadStream;
+export type ExportWorkspaceDumpResponse = ReadStream;

package/dist/documents/document.d.ts

@@ -4,13 +4,12 @@ export declare const prefixed: (type: DocumentType) => string;
 export declare enum DocumentType {
     USER = "us",
     GROUP = "gr",
-    WORKSPACE = "workspace",
     CONFIG = "config",
     TEMPLATE = "template",
-    APP = "app",
+    WORKSPACE = "app",
     DEV = "dev",
-    APP_DEV = "app_dev",
-    APP_METADATA = "app_metadata",
+    WORKSPACE_DEV = "app_dev",
+    WORKSPACE_METADATA = "app_metadata",
     ROLE = "role",
     DEV_INFO = "devinfo",
     AUTOMATION_LOG = "log_au",

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

@@ -16,7 +16,7 @@ export type QuotaTriggers = {
     [key: string]: string | undefined;
 };
 export interface StaticUsage {
-    [StaticQuotaName.APPS]: number;
+    [StaticQuotaName.WORKSPACES]: number;
     [StaticQuotaName.PLUGINS]: number;
     [StaticQuotaName.USERS]: number;
     [StaticQuotaName.CREATORS]: number;

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

@@ -1,6 +1,6 @@
 import { Document } from "../document";
 export declare enum ScheduleType {
-    APP_BACKUP = "app_backup"
+    WORKSPACE_BACKUP = "app_backup"
 }
 export declare enum ScheduleRepeatPeriod {
     DAILY = "daily",
@@ -14,8 +14,8 @@ export interface Schedule extends Document {
     repeat: ScheduleRepeatPeriod;
     metadata: ScheduleMetadata;
 }
-export type ScheduleMetadata = AppBackupScheduleMetadata;
-export declare const isAppBackupMetadata: (type: ScheduleType, metadata: ScheduleMetadata) => metadata is AppBackupScheduleMetadata;
-export interface AppBackupScheduleMetadata {
+export type ScheduleMetadata = WorkspaceBackupScheduleMetadata;
+export declare const isAppBackupMetadata: (type: ScheduleType, metadata: ScheduleMetadata) => metadata is WorkspaceBackupScheduleMetadata;
+export interface WorkspaceBackupScheduleMetadata {
     apps: string[];
 }

package/dist/documents/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./account";
-export * from "./app";
+export * from "./document";
 export * from "./global";
 export * from "./platform";
-export * from "./document";
 export * from "./pouch";
+export * from "./workspace";

package/dist/documents/{app → workspace}/backup.d.ts

@@ -1,57 +1,57 @@
-import { Document } from "../document";
 import { User } from "../../";
-export declare enum AppBackupType {
+import { Document } from "../document";
+export declare enum BackupType {
     BACKUP = "backup",
     RESTORE = "restore"
 }
-export declare enum AppBackupStatus {
+export declare enum BackupStatus {
     STARTED = "started",
     PENDING = "pending",
     COMPLETE = "complete",
     FAILED = "failed"
 }
-export declare enum AppBackupTrigger {
+export declare enum BackupTrigger {
     PUBLISH = "publish",
     MANUAL = "manual",
     SCHEDULED = "scheduled",
     RESTORING = "restoring"
 }
-export interface AppBackupContents {
+export interface WorkspaceBackupContents {
     datasources: string[];
     screens: string[];
     automations: string[];
 }
-export interface AppBackupMetadata {
+export interface WorkspaceBackupMetadata {
     appId: string;
-    trigger?: AppBackupTrigger;
-    type: AppBackupType;
-    status: AppBackupStatus;
+    trigger?: BackupTrigger;
+    type: BackupType;
+    status: BackupStatus;
     name?: string;
     createdBy?: string | User;
     timestamp: string;
     finishedAt?: string;
     startedAt?: string;
-    contents?: AppBackupContents;
+    contents?: WorkspaceBackupContents;
 }
-export interface AppBackup extends Document, AppBackupMetadata {
+export interface WorkspaceBackup extends Document, WorkspaceBackupMetadata {
     _id: string;
     filename?: string;
 }
-export type AppBackupFetchOpts = {
-    trigger?: AppBackupTrigger;
-    type?: AppBackupType;
+export type BackupFetchOpts = {
+    trigger?: BackupTrigger;
+    type?: BackupType;
     limit?: number;
     page?: string;
     paginate?: boolean;
     startDate?: string;
     endDate?: string;
 };
-export interface AppBackupQueueData {
+export interface WorkspaceBackupQueueData {
     appId: string;
     docId: string;
     docRev: string;
     export?: {
-        trigger: AppBackupTrigger;
+        trigger: BackupTrigger;
         name?: string;
         createdBy?: string;
     };

package/dist/documents/{app → workspace}/view.d.ts

@@ -32,9 +32,11 @@ export interface View {
 export interface BasicViewFieldMetadata extends UIFieldMetadata {
     readonly?: boolean;
     columns?: Record<string, RelationSchemaField>;
+    displayName?: string;
 }
 export interface RelationSchemaField extends UIFieldMetadata {
     readonly?: boolean;
+    displayName?: string;
 }
 export interface NumericCalculationFieldMetadata extends BasicViewFieldMetadata {
     calculationType: CalculationType.MIN | CalculationType.MAX | CalculationType.SUM | CalculationType.AVG;