@budibase/types 2.9.19 → 2.9.20

package/dist/core/installation.d.ts

@@ -0,0 +1,4 @@
+export declare enum ServiceType {
+    WORKER = "worker",
+    APPS = "apps"
+}

package/dist/documents/account/account.d.ts

@@ -0,0 +1,78 @@
+import { Feature, Hosting, License, PlanType, Quotas } from "../../sdk";
+import { DeepPartial } from "../../shared";
+import { QuotaUsage } from "../global";
+export interface CreateAccount {
+    email: string;
+    tenantId: string;
+    hosting: Hosting;
+    authType: AuthType;
+    registrationStep?: string;
+    tenantName?: string;
+    name?: string;
+    size?: string;
+    profession?: string;
+}
+export interface CreatePassswordAccount extends CreateAccount {
+    password: string;
+}
+export declare const isCreatePasswordAccount: (account: CreateAccount) => account is CreatePassswordAccount;
+export interface LicenseOverrides {
+    features?: Feature[];
+    quotas?: DeepPartial<Quotas>;
+}
+export interface Account extends CreateAccount {
+    accountId: string;
+    createdAt: number;
+    verified: boolean;
+    verificationSent: boolean;
+    tier: string;
+    planType?: PlanType;
+    /** @deprecated */
+    planTier?: number;
+    license?: License;
+    installId?: string;
+    installTenantId?: string;
+    installVersion?: string;
+    stripeCustomerId?: string;
+    licenseKey?: string;
+    licenseKeyActivatedAt?: number;
+    licenseRequestedAt?: number;
+    licenseOverrides?: LicenseOverrides;
+    quotaUsage?: QuotaUsage;
+    offlineLicenseToken?: string;
+}
+export interface PasswordAccount extends Account {
+    password: string;
+}
+export declare const isPasswordAccount: (account: Account) => account is PasswordAccount;
+export interface CloudAccount extends Account {
+    password?: string;
+    budibaseUserId: string;
+}
+export declare const isCloudAccount: (account: Account) => account is CloudAccount;
+export declare const isSelfHostAccount: (account: Account) => boolean;
+export declare const isSSOAccount: (account: Account) => account is SSOAccount;
+export declare enum AccountSSOProviderType {
+    GOOGLE = "google",
+    MICROSOFT = "microsoft"
+}
+export declare enum AccountSSOProvider {
+    GOOGLE = "google",
+    MICROSOFT = "microsoft"
+}
+export interface AccountSSO {
+    provider: AccountSSOProvider;
+    providerType: AccountSSOProviderType;
+    oauth2?: OAuthTokens;
+    pictureUrl?: string;
+    thirdPartyProfile: any;
+}
+export declare type SSOAccount = (Account | CloudAccount) & AccountSSO;
+export declare enum AuthType {
+    SSO = "sso",
+    PASSWORD = "password"
+}
+export interface OAuthTokens {
+    accessToken: string;
+    refreshToken: string;
+}

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

@@ -0,0 +1,2 @@
+export * from "./account";
+export * from "./user";

package/{src/documents/account/user.ts → dist/documents/account/user.d.ts}

@@ -1,10 +1,9 @@
 export interface CreateAccountUserActivity {
-  accountId: string
-  userId: string
-  timestamp: number
+    accountId: string;
+    userId: string;
+    timestamp: number;
 }
-
 export interface AccountUserActivity extends CreateAccountUserActivity {
-  PK: string
-  SK: string
+    PK: string;
+    SK: string;
 }

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

@@ -0,0 +1,61 @@
+import { User, Document } from "../";
+import { SocketSession } from "../../sdk";
+export declare type AppMetadataErrors = {
+    [key: string]: string[];
+};
+export interface App extends Document {
+    appId: string;
+    type: string;
+    version: string;
+    componentLibraries: string[];
+    name: string;
+    url: string | undefined;
+    template: string | undefined;
+    instance: AppInstance;
+    tenantId: string;
+    status: string;
+    theme?: string;
+    customTheme?: AppCustomTheme;
+    revertableVersion?: string;
+    lockedBy?: User;
+    sessions?: SocketSession[];
+    navigation?: AppNavigation;
+    automationErrors?: AppMetadataErrors;
+    icon?: AppIcon;
+    features?: AppFeatures;
+}
+export interface AppInstance {
+    _id: string;
+}
+export interface AppNavigation {
+    navigation: string;
+    title: string;
+    navWidth: string;
+    sticky?: boolean;
+    hideLogo?: boolean;
+    logoUrl?: string;
+    hideTitle?: boolean;
+    navBackground?: string;
+    navTextColor?: string;
+    links?: AppNavigationLink[];
+}
+export interface AppNavigationLink {
+    text: string;
+    url: string;
+    id?: string;
+    roleId?: string;
+}
+export interface AppCustomTheme {
+    buttonBorderRadius?: string;
+    primaryColor?: string;
+    primaryColorHover?: string;
+    navTextColor?: string;
+    navBackground?: string;
+}
+export interface AppIcon {
+    name: string;
+    color: string;
+}
+export interface AppFeatures {
+    componentValidation?: boolean;
+}

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

@@ -0,0 +1,192 @@
+/// <reference types="node" />
+import { Document } from "../document";
+import { EventEmitter } from "events";
+import { User } from "../global";
+export declare enum AutomationIOType {
+    OBJECT = "object",
+    STRING = "string",
+    BOOLEAN = "boolean",
+    NUMBER = "number",
+    ARRAY = "array",
+    JSON = "json",
+    DATE = "date"
+}
+export declare enum AutomationCustomIOType {
+    TABLE = "table",
+    ROW = "row",
+    ROWS = "rows",
+    WIDE = "wide",
+    QUERY = "query",
+    QUERY_PARAMS = "queryParams",
+    QUERY_LIMIT = "queryLimit",
+    LOOP_OPTION = "loopOption",
+    ITEM = "item",
+    CODE = "code",
+    FILTERS = "filters",
+    COLUMN = "column",
+    TRIGGER_SCHEMA = "triggerSchema",
+    CRON = "cron",
+    WEBHOOK_URL = "webhookUrl"
+}
+export declare enum AutomationTriggerStepId {
+    ROW_SAVED = "ROW_SAVED",
+    ROW_UPDATED = "ROW_UPDATED",
+    ROW_DELETED = "ROW_DELETED",
+    WEBHOOK = "WEBHOOK",
+    APP = "APP",
+    CRON = "CRON"
+}
+export declare enum AutomationStepType {
+    LOGIC = "LOGIC",
+    ACTION = "ACTION",
+    TRIGGER = "TRIGGER"
+}
+export declare enum AutomationActionStepId {
+    SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
+    CREATE_ROW = "CREATE_ROW",
+    UPDATE_ROW = "UPDATE_ROW",
+    DELETE_ROW = "DELETE_ROW",
+    EXECUTE_BASH = "EXECUTE_BASH",
+    OUTGOING_WEBHOOK = "OUTGOING_WEBHOOK",
+    EXECUTE_SCRIPT = "EXECUTE_SCRIPT",
+    EXECUTE_QUERY = "EXECUTE_QUERY",
+    SERVER_LOG = "SERVER_LOG",
+    DELAY = "DELAY",
+    FILTER = "FILTER",
+    QUERY_ROWS = "QUERY_ROWS",
+    LOOP = "LOOP",
+    COLLECT = "COLLECT",
+    OPENAI = "OPENAI",
+    discord = "discord",
+    slack = "slack",
+    zapier = "zapier",
+    integromat = "integromat"
+}
+export interface EmailInvite {
+    startTime: Date;
+    endTime: Date;
+    summary: string;
+    location?: string;
+    url?: string;
+}
+export interface SendEmailOpts {
+    workspaceId?: string;
+    user: User;
+    from?: string;
+    contents?: string;
+    subject?: string;
+    info?: any;
+    cc?: boolean;
+    bcc?: boolean;
+    automation?: boolean;
+    invite?: EmailInvite;
+}
+export declare const AutomationStepIdArray: (AutomationActionStepId | AutomationTriggerStepId)[];
+export interface Automation extends Document {
+    definition: {
+        steps: AutomationStep[];
+        trigger: AutomationTrigger;
+    };
+    screenId?: string;
+    uiTree?: any;
+    appId: string;
+    live?: boolean;
+    name: string;
+    internal?: boolean;
+    type?: string;
+}
+interface BaseIOStructure {
+    type?: AutomationIOType;
+    customType?: AutomationCustomIOType;
+    title?: string;
+    description?: string;
+    dependsOn?: string;
+    enum?: string[];
+    pretty?: string[];
+    properties?: {
+        [key: string]: BaseIOStructure;
+    };
+    required?: string[];
+}
+interface InputOutputBlock {
+    properties: {
+        [key: string]: BaseIOStructure;
+    };
+    required?: string[];
+}
+export interface AutomationStepSchema {
+    name: string;
+    stepTitle?: string;
+    tagline: string;
+    icon: string;
+    description: string;
+    type: AutomationStepType;
+    internal?: boolean;
+    deprecated?: boolean;
+    stepId: AutomationTriggerStepId | AutomationActionStepId;
+    blockToLoop?: string;
+    inputs: {
+        [key: string]: any;
+    };
+    schema: {
+        inputs: InputOutputBlock;
+        outputs: InputOutputBlock;
+    };
+    custom?: boolean;
+    features?: Partial<Record<AutomationFeature, boolean>>;
+}
+export declare enum AutomationFeature {
+    LOOPING = "LOOPING"
+}
+export interface AutomationStep extends AutomationStepSchema {
+    id: string;
+}
+export interface AutomationTriggerSchema extends AutomationStepSchema {
+    event?: string;
+    cronJobId?: string;
+}
+export interface AutomationTrigger extends AutomationTriggerSchema {
+    id: string;
+}
+export declare enum AutomationStatus {
+    SUCCESS = "success",
+    ERROR = "error",
+    STOPPED = "stopped",
+    STOPPED_ERROR = "stopped_error",
+    NO_ITERATIONS = "no_iterations"
+}
+export interface AutomationResults {
+    automationId?: string;
+    status?: AutomationStatus;
+    trigger?: any;
+    steps: {
+        stepId: AutomationTriggerStepId | AutomationActionStepId;
+        inputs: {
+            [key: string]: any;
+        };
+        outputs: {
+            [key: string]: any;
+        };
+    }[];
+}
+export interface AutomationLog extends AutomationResults, Document {
+    automationName: string;
+    _rev?: string;
+}
+export interface AutomationLogPage {
+    data: AutomationLog[];
+    hasNextPage: boolean;
+    nextPage?: string;
+}
+export declare type AutomationStepInput = {
+    inputs: Record<string, any>;
+    context: Record<string, any>;
+    emitter: EventEmitter;
+    appId: string;
+    apiKey?: string;
+};
+export interface AutomationMetadata extends Document {
+    errorCount?: number;
+    automationChainCount?: number;
+}
+export {};

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

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

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

@@ -0,0 +1,10 @@
+import { Document } from "../document";
+export interface Component extends Document {
+    _instanceName: string;
+    _styles: {
+        [key: string]: any;
+    };
+    _component: string;
+    _children?: Component[];
+    [key: string]: any;
+}

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

@@ -0,0 +1,49 @@
+import { Document } from "../document";
+import { SourceName } from "../../sdk";
+import { Table } from "./table";
+export interface Datasource extends Document {
+    type: string;
+    name?: string;
+    source: SourceName;
+    config?: Record<string, any>;
+    plus?: boolean;
+    entities?: {
+        [key: string]: Table;
+    };
+}
+export declare enum RestAuthType {
+    BASIC = "basic",
+    BEARER = "bearer"
+}
+export interface RestBasicAuthConfig {
+    username: string;
+    password: string;
+}
+export interface RestBearerAuthConfig {
+    token: string;
+}
+export interface RestAuthConfig {
+    _id: string;
+    name: string;
+    type: RestAuthType;
+    config: RestBasicAuthConfig | RestBearerAuthConfig;
+}
+export interface RestConfig {
+    url: string;
+    rejectUnauthorized: boolean;
+    defaultHeaders: {
+        [key: string]: any;
+    };
+    legacyHttpParser: boolean;
+    authConfigs: RestAuthConfig[];
+    staticVariables: {
+        [key: string]: string;
+    };
+    dynamicVariables: [
+        {
+            name: string;
+            queryId: string;
+            value: string;
+        }
+    ];
+}

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

@@ -0,0 +1,16 @@
+export * from "./app";
+export * from "./automation";
+export * from "./datasource";
+export * from "./layout";
+export * from "./query";
+export * from "./role";
+export * from "./table";
+export * from "./screen";
+export * from "./view";
+export * from "../document";
+export * from "./row";
+export * from "./user";
+export * from "./backup";
+export * from "./webhook";
+export * from "./links";
+export * from "./component";

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

@@ -0,0 +1,4 @@
+import { Document } from "../document";
+export interface Layout extends Document {
+    props: any;
+}

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

@@ -0,0 +1,19 @@
+import { Document } from "../document";
+export interface LinkDocument extends Document {
+    type: string;
+    doc1: {
+        rowId: string;
+        fieldName: string;
+        tableId: string;
+    };
+    doc2: {
+        rowId: string;
+        fieldName: string;
+        tableId: string;
+    };
+}
+export interface LinkDocumentValue {
+    id: string;
+    thisId: string;
+    fieldName: string;
+}

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

@@ -0,0 +1,49 @@
+import { Document } from "../document";
+export interface Query extends Document {
+    datasourceId: string;
+    name: string;
+    parameters: QueryParameter[];
+    fields: RestQueryFields | any;
+    transformer: string | null;
+    schema: any;
+    readable: boolean;
+    queryVerb: string;
+}
+export interface QueryParameter {
+    name: string;
+    default: string;
+}
+export interface RestQueryFields {
+    path: string;
+    queryString?: string;
+    headers: {
+        [key: string]: any;
+    };
+    disabledHeaders: {
+        [key: string]: any;
+    };
+    requestBody: any;
+    bodyType: string;
+    json: object;
+    method: string;
+    authConfigId: string;
+    pagination: PaginationConfig | null;
+    paginationValues: PaginationValues | null;
+}
+export interface PaginationConfig {
+    type: string;
+    location: string;
+    pageParam: string;
+    sizeParam: string | null;
+    responseParam: string | null;
+}
+export interface PaginationValues {
+    page: string | number | null;
+    limit: number | null;
+}
+export interface PreviewQueryRequest extends Omit<Query, "parameters"> {
+    parameters: {};
+    flags?: {
+        urlName?: boolean;
+    };
+}

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

@@ -0,0 +1,9 @@
+import { Document } from "../document";
+export interface Role extends Document {
+    permissionId: string;
+    inherits?: string;
+    permissions: {
+        [key: string]: string[];
+    };
+    version?: string;
+}

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

@@ -0,0 +1,31 @@
+import { Document } from "../document";
+export declare enum FieldType {
+    STRING = "string",
+    LONGFORM = "longform",
+    OPTIONS = "options",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    ARRAY = "array",
+    DATETIME = "datetime",
+    ATTACHMENT = "attachment",
+    LINK = "link",
+    FORMULA = "formula",
+    AUTO = "auto",
+    JSON = "json",
+    INTERNAL = "internal",
+    BARCODEQR = "barcodeqr",
+    BIGINT = "bigint"
+}
+export interface RowAttachment {
+    size: number;
+    name: string;
+    extension: string;
+    key: string;
+    url?: string;
+}
+export interface Row extends Document {
+    type?: string;
+    tableId?: string;
+    _viewId?: string;
+    [key: string]: any;
+}

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

@@ -0,0 +1,22 @@
+import { Document } from "../document";
+import { Component } from "./component";
+export interface ScreenProps extends Component {
+    size?: string;
+    gap?: string;
+    direction?: string;
+    vAlign?: string;
+    hAlign?: string;
+}
+export interface ScreenRouting {
+    route: string;
+    roleId: string;
+    homeScreen?: boolean;
+}
+export interface Screen extends Document {
+    layoutId?: string;
+    showNavigation?: boolean;
+    width?: string;
+    routing: ScreenRouting;
+    props: ScreenProps;
+    name?: string;
+}

package/dist/documents/app/table/constants.d.ts

@@ -0,0 +1,8 @@
+export declare enum RelationshipType {
+    ONE_TO_MANY = "one-to-many",
+    MANY_TO_ONE = "many-to-one",
+    MANY_TO_MANY = "many-to-many"
+}
+export declare enum AutoReason {
+    FOREIGN_KEY = "foreign_key"
+}

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

@@ -0,0 +1,3 @@
+export * from "./table";
+export * from "./schema";
+export * from "./constants";