@budibase/types 2.9.19 → 2.9.20

package/dist/sdk/db.d.ts

@@ -0,0 +1,91 @@
+/// <reference types="pouchdb-find" />
+/// <reference types="node" />
+import Nano from "@budibase/nano";
+import { AllDocsResponse, AnyDocument, Document } from "../";
+import { Writable } from "stream";
+export declare enum SearchIndex {
+    ROWS = "rows",
+    AUDIT = "audit",
+    USER = "user"
+}
+export declare type PouchOptions = {
+    inMemory?: boolean;
+    replication?: boolean;
+    onDisk?: boolean;
+    find?: boolean;
+};
+export declare enum SortOption {
+    ASCENDING = "asc",
+    DESCENDING = "desc"
+}
+export declare type CouchFindOptions = {
+    selector: PouchDB.Find.Selector;
+    fields?: string[];
+    sort?: {
+        [key: string]: SortOption;
+    }[];
+    limit?: number;
+    skip?: number;
+    bookmark?: string;
+};
+export declare type DatabaseOpts = {
+    skip_setup?: boolean;
+};
+export declare type DatabasePutOpts = {
+    force?: boolean;
+};
+export declare type DatabaseCreateIndexOpts = {
+    index: {
+        fields: string[];
+        name?: string | undefined;
+        ddoc?: string | undefined;
+        type?: string | undefined;
+    };
+};
+export declare type DatabaseDeleteIndexOpts = {
+    name: string;
+    ddoc: string;
+    type?: string | undefined;
+};
+export declare type DatabaseQueryOpts = {
+    include_docs?: boolean;
+    startkey?: string;
+    endkey?: string;
+    limit?: number;
+    skip?: number;
+    descending?: boolean;
+    key?: string;
+    keys?: string[];
+    group?: boolean;
+    startkey_docid?: string;
+};
+export declare const isDocument: (doc: any) => doc is Document;
+export interface DatabaseDumpOpts {
+    filter?: (doc: AnyDocument) => boolean;
+    batch_size?: number;
+    batch_limit?: number;
+    style?: "main_only" | "all_docs";
+    timeout?: number;
+    doc_ids?: string[];
+    query_params?: any;
+    view?: string;
+    selector?: any;
+}
+export interface Database {
+    name: string;
+    exists(): Promise<boolean>;
+    checkSetup(): Promise<Nano.DocumentScope<any>>;
+    get<T>(id?: string): Promise<T>;
+    remove(id: string | Document, rev?: string): Promise<Nano.DocumentDestroyResponse>;
+    put(document: AnyDocument, opts?: DatabasePutOpts): Promise<Nano.DocumentInsertResponse>;
+    bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>;
+    allDocs<T>(params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>;
+    query<T>(viewName: string, params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>;
+    destroy(): Promise<Nano.OkResponse | void>;
+    compact(): Promise<Nano.OkResponse | void>;
+    dump(stream: Writable, opts?: DatabaseDumpOpts): Promise<any>;
+    load(...args: any[]): Promise<any>;
+    createIndex(...args: any[]): Promise<any>;
+    deleteIndex(...args: any[]): Promise<any>;
+    getIndexes(...args: any[]): Promise<any>;
+}

package/dist/sdk/environmentVariables.d.ts

@@ -0,0 +1,4 @@
+export declare enum AppEnvironment {
+    PRODUCTION = "production",
+    DEVELOPMENT = "development"
+}

package/{src/sdk/events/account.ts → dist/sdk/events/account.d.ts}

@@ -1,15 +1,12 @@
-import { BaseEvent } from "./event"
-
+import { BaseEvent } from "./event";
 export interface AccountCreatedEvent extends BaseEvent {
-  tenantId: string
-  registrationStep?: string
+    tenantId: string;
+    registrationStep?: string;
 }
-
 export interface AccountDeletedEvent extends BaseEvent {
-  tenantId: string
-  registrationStep?: string
+    tenantId: string;
+    registrationStep?: string;
 }
-
 export interface AccountVerifiedEvent extends BaseEvent {
-  tenantId: string
+    tenantId: string;
 }

package/dist/sdk/events/app.d.ts

@@ -0,0 +1,74 @@
+import { BaseEvent } from "./event";
+export interface AppCreatedEvent extends BaseEvent {
+    appId: string;
+    version: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppUpdatedEvent extends BaseEvent {
+    appId: string;
+    version: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppDeletedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppPublishedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppUnpublishedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppFileImportedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppTemplateImportedEvent extends BaseEvent {
+    appId: string;
+    templateKey: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppVersionUpdatedEvent extends BaseEvent {
+    appId: string;
+    currentVersion: string;
+    updatedToVersion: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppVersionRevertedEvent extends BaseEvent {
+    appId: string;
+    currentVersion: string;
+    revertedToVersion: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppRevertedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AppExportedEvent extends BaseEvent {
+    appId: string;
+    audited: {
+        name: string;
+    };
+}

package/dist/sdk/events/auditLog.d.ts

@@ -0,0 +1,8 @@
+import { BaseEvent } from "./event";
+import { AuditLogSearchParams } from "../../api";
+export interface AuditLogFilteredEvent extends BaseEvent {
+    filters: AuditLogSearchParams;
+}
+export interface AuditLogDownloadedEvent extends BaseEvent {
+    filters: AuditLogSearchParams;
+}

package/dist/sdk/events/auth.d.ts

@@ -0,0 +1,29 @@
+import { BaseEvent } from "./event";
+import { ConfigType } from "../../documents";
+export declare type LoginSource = "local" | "google" | "oidc" | "google-internal";
+export declare type SSOType = ConfigType.OIDC | ConfigType.GOOGLE;
+export interface LoginEvent extends BaseEvent {
+    userId: string;
+    source: LoginSource;
+    audited: {
+        email: string;
+    };
+}
+export interface LogoutEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email?: string;
+    };
+}
+export interface SSOCreatedEvent extends BaseEvent {
+    type: SSOType;
+}
+export interface SSOUpdatedEvent extends BaseEvent {
+    type: SSOType;
+}
+export interface SSOActivatedEvent extends BaseEvent {
+    type: SSOType;
+}
+export interface SSODeactivatedEvent extends BaseEvent {
+    type: SSOType;
+}

package/dist/sdk/events/automation.d.ts

@@ -0,0 +1,56 @@
+import { BaseEvent } from "./event";
+export interface AutomationCreatedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AutomationTriggerUpdatedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+}
+export interface AutomationDeletedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AutomationTestedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+}
+export interface AutomationStepCreatedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+    stepId: string;
+    stepType: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AutomationStepDeletedEvent extends BaseEvent {
+    appId: string;
+    automationId: string;
+    triggerId: string;
+    triggerType: string;
+    stepId: string;
+    stepType: string;
+    audited: {
+        name: string;
+    };
+}
+export interface AutomationsRunEvent extends BaseEvent {
+    count: number;
+}

package/{src/sdk/events/backfill.ts → dist/sdk/events/backfill.d.ts}

@@ -1,46 +1,38 @@
-import { BaseEvent, Event } from "./event"
-
+import { BaseEvent, Event } from "./event";
 export interface AppBackfillSucceededEvent extends BaseEvent {
-  appId: string
-  automations: number
-  datasources: number
-  layouts: number
-  queries: number
-  roles: number
-  tables: number
-  screens: number
-  errors?: string[]
-  errorCount?: number
-}
-
+    appId: string;
+    automations: number;
+    datasources: number;
+    layouts: number;
+    queries: number;
+    roles: number;
+    tables: number;
+    screens: number;
+    errors?: string[];
+    errorCount?: number;
+}
 export interface AppBackfillFailedEvent extends BaseEvent {
-  error: string
+    error: string;
 }
-
 export interface TenantBackfillSucceededEvent extends BaseEvent {
-  apps: number
-  users: number
-
-  usage: any
-  errors?: [string]
-  errorCount?: number
-}
-
+    apps: number;
+    users: number;
+    usage: any;
+    errors?: [string];
+    errorCount?: number;
+}
 export interface TenantBackfillFailedEvent extends BaseEvent {
-  error: string
+    error: string;
+}
+export interface InstallationBackfillSucceededEvent extends BaseEvent {
 }
-
-export interface InstallationBackfillSucceededEvent extends BaseEvent {}
-
 export interface InstallationBackfillFailedEvent extends BaseEvent {
-  error: string
+    error: string;
 }
-
 export interface BackfillMetadata extends BaseEvent {
-  eventWhitelist: Event[]
+    eventWhitelist: Event[];
 }
-
 export interface CachedEvent extends BaseEvent {
-  event: Event
-  properties: any
+    event: Event;
+    properties: any;
 }

package/dist/sdk/events/backup.d.ts

@@ -0,0 +1,15 @@
+import { BaseEvent } from "./event";
+import { AppBackupTrigger, AppBackupType } from "../../documents";
+export interface AppBackupRestoreEvent extends BaseEvent {
+    appId: string;
+    restoreId: string;
+    backupCreatedAt: string;
+    name: string;
+}
+export interface AppBackupTriggeredEvent extends BaseEvent {
+    backupId: string;
+    appId: string;
+    trigger: AppBackupTrigger;
+    type: AppBackupType;
+    name: string;
+}

package/dist/sdk/events/datasource.d.ts

@@ -0,0 +1,16 @@
+import { BaseEvent } from "./event";
+export interface DatasourceCreatedEvent extends BaseEvent {
+    datasourceId: string;
+    source: string;
+    custom: boolean;
+}
+export interface DatasourceUpdatedEvent extends BaseEvent {
+    datasourceId: string;
+    source: string;
+    custom: boolean;
+}
+export interface DatasourceDeletedEvent extends BaseEvent {
+    datasourceId: string;
+    source: string;
+    custom: boolean;
+}

package/dist/sdk/events/email.d.ts

@@ -0,0 +1,5 @@
+import { BaseEvent } from "./event";
+export interface SMTPCreatedEvent extends BaseEvent {
+}
+export interface SMTPUpdatedEvent extends BaseEvent {
+}

package/{src/sdk/events/environmentVariable.ts → dist/sdk/events/environmentVariable.d.ts}

@@ -1,14 +1,11 @@
-import { BaseEvent } from "./event"
-
+import { BaseEvent } from "./event";
 export interface EnvironmentVariableCreatedEvent extends BaseEvent {
-  name: string
-  environments: string[]
+    name: string;
+    environments: string[];
 }
-
 export interface EnvironmentVariableDeletedEvent extends BaseEvent {
-  name: string
+    name: string;
 }
-
 export interface EnvironmentVariableUpgradePanelOpenedEvent extends BaseEvent {
-  userId: string
+    userId: string;
 }

package/dist/sdk/events/event.d.ts

@@ -0,0 +1,155 @@
+import { Hosting } from "../hosting";
+import { Group, Identity } from "./identification";
+export declare enum Event {
+    USER_CREATED = "user:created",
+    USER_UPDATED = "user:updated",
+    USER_DELETED = "user:deleted",
+    USER_ONBOARDING_COMPLETE = "user:onboarding:complete",
+    USER_PERMISSION_ADMIN_ASSIGNED = "user:admin:assigned",
+    USER_PERMISSION_ADMIN_REMOVED = "user:admin:removed",
+    USER_PERMISSION_BUILDER_ASSIGNED = "user:builder:assigned",
+    USER_PERMISSION_BUILDER_REMOVED = "user:builder:removed",
+    USER_INVITED = "user:invited",
+    USER_INVITED_ACCEPTED = "user:invite:accepted",
+    USER_PASSWORD_FORCE_RESET = "user:password:force:reset",
+    USER_PASSWORD_UPDATED = "user:password:updated",
+    USER_PASSWORD_RESET_REQUESTED = "user:password:reset:requested",
+    USER_PASSWORD_RESET = "user:password:reset",
+    USER_DATA_COLLABORATION = "user:data:collaboration",
+    EMAIL_SMTP_CREATED = "email:smtp:created",
+    EMAIL_SMTP_UPDATED = "email:smtp:updated",
+    AUTH_SSO_CREATED = "auth:sso:created",
+    AUTH_SSO_UPDATED = "auth:sso:updated",
+    AUTH_SSO_ACTIVATED = "auth:sso:activated",
+    AUTH_SSO_DEACTIVATED = "auth:sso:deactivated",
+    AUTH_LOGIN = "auth:login",
+    AUTH_LOGOUT = "auth:logout",
+    ORG_NAME_UPDATED = "org:info:name:updated",
+    ORG_LOGO_UPDATED = "org:info:logo:updated",
+    ORG_PLATFORM_URL_UPDATED = "org:platformurl:updated",
+    INSTALLATION_VERSION_CHECKED = "installation:version:checked",
+    INSTALLATION_VERSION_UPGRADED = "installation:version:upgraded",
+    INSTALLATION_VERSION_DOWNGRADED = "installation:version:downgraded",
+    INSTALLATION_FIRST_STARTUP = "installation:firstStartup",
+    ANALYTICS_OPT_OUT = "analytics:opt:out",
+    ANALYTICS_OPT_IN = "analytics:opt:in",
+    APP_CREATED = "app:created",
+    APP_UPDATED = "app:updated",
+    APP_DELETED = "app:deleted",
+    APP_PUBLISHED = "app:published",
+    APP_UNPUBLISHED = "app:unpublished",
+    APP_TEMPLATE_IMPORTED = "app:template:imported",
+    APP_FILE_IMPORTED = "app:file:imported",
+    APP_VERSION_UPDATED = "app:version:updated",
+    APP_VERSION_REVERTED = "app:version:reverted",
+    APP_REVERTED = "app:reverted",
+    APP_EXPORTED = "app:exported",
+    ROLE_CREATED = "role:created",
+    ROLE_UPDATED = "role:updated",
+    ROLE_DELETED = "role:deleted",
+    ROLE_ASSIGNED = "role:assigned",
+    ROLE_UNASSIGNED = "role:unassigned",
+    SERVED_BUILDER = "served:builder",
+    SERVED_APP = "served:app",
+    SERVED_APP_PREVIEW = "served:app:preview",
+    DATASOURCE_CREATED = "datasource:created",
+    DATASOURCE_UPDATED = "datasource:updated",
+    DATASOURCE_DELETED = "datasource:deleted",
+    QUERY_CREATED = "query:created",
+    QUERY_UPDATED = "query:updated",
+    QUERY_DELETED = "query:deleted",
+    QUERY_IMPORT = "query:import",
+    QUERIES_RUN = "queries:run",
+    QUERY_PREVIEWED = "query:previewed",
+    TABLE_CREATED = "table:created",
+    TABLE_UPDATED = "table:updated",
+    TABLE_DELETED = "table:deleted",
+    TABLE_EXPORTED = "table:exported",
+    TABLE_IMPORTED = "table:imported",
+    TABLE_DATA_IMPORTED = "table:data:imported",
+    VIEW_CREATED = "view:created",
+    VIEW_UPDATED = "view:updated",
+    VIEW_DELETED = "view:deleted",
+    VIEW_EXPORTED = "view:exported",
+    VIEW_FILTER_CREATED = "view:filter:created",
+    VIEW_FILTER_UPDATED = "view:filter:updated",
+    VIEW_FILTER_DELETED = "view:filter:deleted",
+    VIEW_CALCULATION_CREATED = "view:calculation:created",
+    VIEW_CALCULATION_UPDATED = "view:calculation:updated",
+    VIEW_CALCULATION_DELETED = "view:calculation:deleted",
+    ROWS_CREATED = "rows:created",
+    ROWS_IMPORTED = "rows:imported",
+    COMPONENT_CREATED = "component:created",
+    COMPONENT_DELETED = "component:deleted",
+    SCREEN_CREATED = "screen:created",
+    SCREEN_DELETED = "screen:deleted",
+    LAYOUT_CREATED = "layout:created",
+    LAYOUT_DELETED = "layout:deleted",
+    AUTOMATION_CREATED = "automation:created",
+    AUTOMATION_DELETED = "automation:deleted",
+    AUTOMATION_TESTED = "automation:tested",
+    AUTOMATIONS_RUN = "automations:run",
+    AUTOMATION_STEP_CREATED = "automation:step:created",
+    AUTOMATION_STEP_DELETED = "automation:step:deleted",
+    AUTOMATION_TRIGGER_UPDATED = "automation:trigger:updated",
+    LICENSE_PLAN_CHANGED = "license:plan:changed",
+    LICENSE_ACTIVATED = "license:activated",
+    LICENSE_PAYMENT_FAILED = "license:payment:failed",
+    LICENSE_PAYMENT_RECOVERED = "license:payment:recovered",
+    LICENSE_CHECKOUT_OPENED = "license:checkout:opened",
+    LICENSE_CHECKOUT_SUCCESS = "license:checkout:success",
+    LICENSE_PORTAL_OPENED = "license:portal:opened",
+    ACCOUNT_CREATED = "account:created",
+    ACCOUNT_DELETED = "account:deleted",
+    ACCOUNT_VERIFIED = "account:verified",
+    APP_BACKFILL_SUCCEEDED = "app:backfill:succeeded",
+    APP_BACKFILL_FAILED = "app:backfill:failed",
+    TENANT_BACKFILL_SUCCEEDED = "tenant:backfill:succeeded",
+    TENANT_BACKFILL_FAILED = "tenant:backfill:failed",
+    INSTALLATION_BACKFILL_SUCCEEDED = "installation:backfill:succeeded",
+    INSTALLATION_BACKFILL_FAILED = "installation:backfill:failed",
+    USER_GROUP_CREATED = "user_group:created",
+    USER_GROUP_UPDATED = "user_group:updated",
+    USER_GROUP_DELETED = "user_group:deleted",
+    USER_GROUP_USERS_ADDED = "user_group:user_added",
+    USER_GROUP_USERS_REMOVED = "user_group:users_deleted",
+    USER_GROUP_PERMISSIONS_EDITED = "user_group:permissions_edited",
+    USER_GROUP_ONBOARDING = "user_group:onboarding_added",
+    PLUGIN_INIT = "plugin:init",
+    PLUGIN_IMPORTED = "plugin:imported",
+    PLUGIN_DELETED = "plugin:deleted",
+    APP_BACKUP_RESTORED = "app:backup:restored",
+    APP_BACKUP_TRIGGERED = "app:backup:triggered",
+    ENVIRONMENT_VARIABLE_CREATED = "environment_variable:created",
+    ENVIRONMENT_VARIABLE_DELETED = "environment_variable:deleted",
+    ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable:upgrade_panel_opened",
+    AUDIT_LOGS_FILTERED = "audit_log:filtered",
+    AUDIT_LOGS_DOWNLOADED = "audit_log:downloaded"
+}
+export declare const UserGroupSyncEvents: Event[];
+export declare const AsyncEvents: Event[];
+export declare const AuditedEventFriendlyName: Record<Event, string | undefined>;
+export interface BaseEvent {
+    version?: string;
+    service?: string;
+    environment?: string;
+    appId?: string;
+    installationId?: string;
+    tenantId?: string;
+    hosting?: Hosting;
+    audited?: {
+        [key: string]: any;
+    };
+}
+export declare type TableExportFormat = "json" | "csv";
+export declare type DocUpdateEvent = {
+    id: string;
+    tenantId: string;
+    appId?: string;
+};
+export interface EventProcessor {
+    processEvent(event: Event, identity: Identity, properties: any, timestamp?: string | number): Promise<void>;
+    identify?(identity: Identity, timestamp?: string | number): Promise<void>;
+    identifyGroup?(group: Group, timestamp?: string | number): Promise<void>;
+    shutdown?(): void;
+}

package/dist/sdk/events/identification.d.ts

@@ -0,0 +1,45 @@
+import { Hosting } from "..";
+export declare enum GroupType {
+    TENANT = "tenant",
+    INSTALLATION = "installation"
+}
+export interface Group {
+    id: string;
+    type: IdentityType;
+    environment: string;
+    hosting: Hosting;
+}
+export interface TenantGroup extends Group {
+    profession?: string;
+    companySize?: string;
+    installationId: string;
+}
+export interface InstallationGroup extends Group {
+    version: string;
+}
+export declare enum IdentityType {
+    USER = "user",
+    TENANT = "tenant",
+    INSTALLATION = "installation"
+}
+export interface HostInfo {
+    ipAddress?: string;
+    userAgent?: string;
+}
+export interface Identity {
+    id: string;
+    type: IdentityType;
+    hosting: Hosting;
+    environment: string;
+    installationId?: string;
+    tenantId?: string;
+    realTenantId?: string;
+    hostInfo?: HostInfo;
+}
+export interface UserIdentity extends Identity {
+    verified: boolean;
+    accountHolder: boolean;
+    providerType?: string;
+    builder?: boolean;
+    admin?: boolean;
+}

package/dist/sdk/events/index.d.ts

@@ -0,0 +1,25 @@
+export * from "./app";
+export * from "./auth";
+export * from "./automation";
+export * from "./email";
+export * from "./datasource";
+export * from "./event";
+export * from "./layout";
+export * from "./license";
+export * from "./version";
+export * from "./query";
+export * from "./role";
+export * from "./rows";
+export * from "./screen";
+export * from "./serve";
+export * from "./table";
+export * from "./user";
+export * from "./view";
+export * from "./account";
+export * from "./backfill";
+export * from "./identification";
+export * from "./userGroup";
+export * from "./plugin";
+export * from "./backup";
+export * from "./environmentVariable";
+export * from "./auditLog";

package/{src/sdk/events/layout.ts → dist/sdk/events/layout.d.ts}

@@ -1,9 +1,7 @@
-import { BaseEvent } from "./event"
-
+import { BaseEvent } from "./event";
 export interface LayoutCreatedEvent extends BaseEvent {
-  layoutId: string
+    layoutId: string;
 }
-
 export interface LayoutDeletedEvent extends BaseEvent {
-  layoutId: string
+    layoutId: string;
 }