@budibase/types 2.9.19 → 2.9.20

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

@@ -0,0 +1,71 @@
+import { FieldType } from "../row";
+import { AutoReason, RelationshipType } from "./constants";
+export interface UIFieldMetadata {
+    order?: number;
+    width?: number;
+    visible?: boolean;
+    icon?: string;
+}
+export interface RelationshipFieldMetadata {
+    main?: boolean;
+    fieldName?: string;
+    tableId?: string;
+    relationshipType?: RelationshipType;
+    through?: string;
+    foreignKey?: string;
+    throughFrom?: string;
+    throughTo?: string;
+}
+export interface AutoColumnFieldMetadata {
+    autocolumn?: boolean;
+    subtype?: string;
+    lastID?: number;
+    autoReason?: AutoReason;
+}
+export interface NumberFieldMetadata {
+    meta?: {
+        toTable: string;
+        toKey: string;
+    };
+}
+export interface DateFieldMetadata {
+    ignoreTimezones?: boolean;
+    timeOnly?: boolean;
+}
+export interface StringFieldMetadata {
+    useRichText?: boolean | null;
+}
+export interface FormulaFieldMetadata {
+    formula?: string;
+    formulaType?: string;
+}
+export interface FieldConstraints {
+    type?: string;
+    email?: boolean;
+    inclusion?: string[];
+    length?: {
+        minimum?: string | number | null;
+        maximum?: string | number | null;
+    };
+    numericality?: {
+        greaterThanOrEqualTo: string | null;
+        lessThanOrEqualTo: string | null;
+    };
+    presence?: boolean | {
+        allowEmpty?: boolean;
+    };
+    datetime?: {
+        latest: string;
+        earliest: string;
+    };
+}
+export interface FieldSchema extends UIFieldMetadata, DateFieldMetadata, RelationshipFieldMetadata, AutoColumnFieldMetadata, StringFieldMetadata, FormulaFieldMetadata, NumberFieldMetadata {
+    type: FieldType;
+    name: string;
+    sortable?: boolean;
+    externalType?: string;
+    constraints?: FieldConstraints;
+}
+export interface TableSchema {
+    [key: string]: FieldSchema;
+}

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

@@ -0,0 +1,33 @@
+import { Document } from "../../document";
+import { View, ViewV2 } from "../view";
+import { RenameColumn } from "../../../sdk";
+import { TableSchema } from "./schema";
+export interface Table extends Document {
+    type?: string;
+    views?: {
+        [key: string]: View | ViewV2;
+    };
+    name: string;
+    primary?: string[];
+    schema: TableSchema;
+    primaryDisplay?: string;
+    sourceId?: string;
+    relatedFormula?: string[];
+    constrained?: string[];
+    sql?: boolean;
+    indexes?: {
+        [key: string]: any;
+    };
+    rows?: {
+        [key: string]: any;
+    };
+    created?: boolean;
+    rowHeight?: number;
+}
+export interface ExternalTable extends Table {
+    sourceId: string;
+}
+export interface TableRequest extends Table {
+    _rename?: RenameColumn;
+    created?: boolean;
+}

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

@@ -0,0 +1,5 @@
+import { Document } from "../document";
+export interface UserMetadata extends Document {
+    roleId: string;
+    email?: string;
+}

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

@@ -0,0 +1,59 @@
+import { SortOrder, SortType } from "../../api";
+import { SearchFilters } from "../../sdk";
+import { UIFieldMetadata } from "./table";
+export interface View {
+    name: string;
+    tableId: string;
+    field?: string;
+    filters: ViewFilter[];
+    schema: ViewSchema;
+    calculation?: ViewCalculation;
+    map?: string;
+    reduce?: any;
+    meta?: Record<string, any>;
+}
+export interface ViewV2 {
+    version: 2;
+    id: string;
+    name: string;
+    primaryDisplay?: string;
+    tableId: string;
+    query?: SearchFilters;
+    sort?: {
+        field: string;
+        order?: SortOrder;
+        type?: SortType;
+    };
+    columns?: string[];
+    schemaUI?: Record<string, UIFieldMetadata>;
+}
+export declare type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema;
+export interface ViewCountOrSumSchema {
+    field: string;
+    value: string;
+}
+/**
+ e.g:
+  "min": {
+    "type": "number"
+  },
+  "max": {
+    "type": "number"
+  }
+ */
+export interface ViewStatisticsSchema {
+    [key: string]: {
+        type: string;
+    };
+}
+export interface ViewFilter {
+    value?: any;
+    condition: string;
+    key: string;
+    conjunction?: string;
+}
+export declare enum ViewCalculation {
+    SUM = "sum",
+    COUNT = "count",
+    STATISTICS = "stats"
+}

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

@@ -0,0 +1,13 @@
+import { Document } from "../document";
+export declare enum WebhookActionType {
+    AUTOMATION = "automation"
+}
+export interface Webhook extends Document {
+    live: boolean;
+    name: string;
+    action: {
+        type: WebhookActionType;
+        target: string;
+    };
+    bodySchema?: any;
+}

package/dist/documents/document.d.ts

@@ -0,0 +1,47 @@
+export declare const SEPARATOR = "_";
+export declare const UNICODE_MAX = "\uFFF0";
+export declare const prefixed: (type: DocumentType) => string;
+export declare enum DocumentType {
+    USER = "us",
+    GROUP = "gr",
+    WORKSPACE = "workspace",
+    CONFIG = "config",
+    TEMPLATE = "template",
+    APP = "app",
+    DEV = "dev",
+    APP_DEV = "app_dev",
+    APP_METADATA = "app_metadata",
+    ROLE = "role",
+    MIGRATIONS = "migrations",
+    DEV_INFO = "devinfo",
+    AUTOMATION_LOG = "log_au",
+    ACCOUNT_METADATA = "acc_metadata",
+    PLUGIN = "plg",
+    DATASOURCE = "datasource",
+    DATASOURCE_PLUS = "datasource_plus",
+    APP_BACKUP = "backup",
+    TABLE = "ta",
+    ROW = "ro",
+    AUTOMATION = "au",
+    LINK = "li",
+    WEBHOOK = "wh",
+    INSTANCE = "inst",
+    LAYOUT = "layout",
+    SCREEN = "screen",
+    QUERY = "query",
+    DEPLOYMENTS = "deployments",
+    METADATA = "metadata",
+    MEM_VIEW = "view",
+    USER_FLAG = "flag",
+    AUTOMATION_METADATA = "meta_au",
+    AUDIT_LOG = "al"
+}
+export interface Document {
+    _id?: string;
+    _rev?: string;
+    createdAt?: string | number;
+    updatedAt?: string;
+}
+export interface AnyDocument extends Document {
+    [key: string]: any;
+}

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

@@ -0,0 +1,16 @@
+import { Document } from "../document";
+import { Event } from "../../sdk";
+export declare const AuditLogSystemUser = "SYSTEM";
+export declare type FallbackInfo = {
+    appName?: string;
+    email?: string;
+};
+export interface AuditLogDoc extends Document {
+    appId?: string;
+    event: Event;
+    userId: string;
+    timestamp: string;
+    metadata: any;
+    name: string;
+    fallback?: FallbackInfo;
+}

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

@@ -0,0 +1,112 @@
+import { Document } from "../document";
+export interface Config<T = any> extends Document {
+    type: ConfigType;
+    config: T;
+}
+export interface SMTPInnerConfig {
+    port: number;
+    host: string;
+    from: string;
+    subject?: string;
+    secure: boolean;
+    auth?: {
+        user: string;
+        pass: string;
+    };
+    connectionTimeout?: any;
+}
+export interface SMTPConfig extends Config<SMTPInnerConfig> {
+}
+/**
+ * Accessible only via pro.
+ */
+export interface SettingsBrandingConfig {
+    faviconUrl?: string;
+    faviconUrlEtag?: string;
+    emailBrandingEnabled?: boolean;
+    testimonialsEnabled?: boolean;
+    platformTitle?: string;
+    loginHeading?: string;
+    loginButton?: string;
+    metaDescription?: string;
+    metaImageUrl?: string;
+    metaTitle?: string;
+}
+export interface SettingsInnerConfig {
+    platformUrl?: string;
+    company?: string;
+    logoUrl?: string;
+    logoUrlEtag?: string;
+    uniqueTenantId?: string;
+    analyticsEnabled?: boolean;
+    isSSOEnforced?: boolean;
+}
+export interface SettingsConfig extends Config<SettingsInnerConfig> {
+}
+export declare type SSOConfigType = ConfigType.GOOGLE | ConfigType.OIDC;
+export declare type SSOConfig = GoogleInnerConfig | OIDCInnerConfig;
+export interface GoogleInnerConfig {
+    clientID: string;
+    clientSecret: string;
+    activated: boolean;
+    /**
+     * @deprecated read only
+     */
+    callbackURL?: string;
+}
+export interface GoogleConfig extends Config<GoogleInnerConfig> {
+}
+export interface OIDCStrategyConfiguration {
+    issuer: string;
+    authorizationURL: string;
+    tokenURL: string;
+    userInfoURL: string;
+    clientID: string;
+    clientSecret: string;
+    callbackURL: string;
+}
+export interface OIDCConfigs {
+    configs: OIDCInnerConfig[];
+}
+export interface OIDCLogosInnerConfig {
+    [key: string]: string;
+}
+export interface OIDCLogosConfig extends Config<OIDCLogosInnerConfig> {
+}
+export interface OIDCInnerConfig {
+    configUrl: string;
+    clientID: string;
+    clientSecret: string;
+    logo: string;
+    name: string;
+    uuid: string;
+    activated: boolean;
+    scopes: string[];
+}
+export interface OIDCConfig extends Config<OIDCConfigs> {
+}
+export interface OIDCWellKnownConfig {
+    issuer: string;
+    authorization_endpoint: string;
+    token_endpoint: string;
+    userinfo_endpoint: string;
+}
+export interface SCIMInnerConfig {
+    enabled: boolean;
+}
+export interface SCIMConfig extends Config<SCIMInnerConfig> {
+}
+export declare const isSettingsConfig: (config: Config) => config is SettingsConfig;
+export declare const isSMTPConfig: (config: Config) => config is SMTPConfig;
+export declare const isGoogleConfig: (config: Config) => config is GoogleConfig;
+export declare const isOIDCConfig: (config: Config) => config is OIDCConfig;
+export declare const isSCIMConfig: (config: Config) => config is SCIMConfig;
+export declare enum ConfigType {
+    SETTINGS = "settings",
+    ACCOUNT = "account",
+    SMTP = "smtp",
+    GOOGLE = "google",
+    OIDC = "oidc",
+    OIDC_LOGOS = "logos_oidc",
+    SCIM = "scim"
+}

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

@@ -0,0 +1,12 @@
+import { Document } from "../document";
+export interface EnvironmentVariablesDoc extends Document {
+    variables: string;
+}
+export declare type EnvironmentVariableValue = {
+    production: string;
+    development: string;
+};
+export declare type EnvironmentVariablesDecrypted = Record<string, EnvironmentVariableValue>;
+export interface EnvironmentVariablesDocDecrypted extends Document {
+    variables: EnvironmentVariablesDecrypted;
+}

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

@@ -0,0 +1,9 @@
+export * from "./config";
+export * from "./user";
+export * from "./userGroup";
+export * from "./plugin";
+export * from "./quotas";
+export * from "./schedule";
+export * from "./templates";
+export * from "./environmentVariables";
+export * from "./auditLogs";

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

@@ -0,0 +1,34 @@
+import { Document } from "../document";
+export declare enum PluginType {
+    DATASOURCE = "datasource",
+    COMPONENT = "component",
+    AUTOMATION = "automation"
+}
+export declare enum PluginSource {
+    NPM = "NPM",
+    GITHUB = "Github",
+    URL = "URL",
+    FILE = "File Upload"
+}
+export interface FileType {
+    path: string;
+    name: string;
+}
+export interface Plugin extends Document {
+    description: string;
+    name: string;
+    version: string;
+    source: PluginSource;
+    package: {
+        [key: string]: any;
+    };
+    hash: string;
+    schema: {
+        type: PluginType;
+        [key: string]: any;
+    };
+    iconFileName?: string;
+    jsUrl?: string;
+    iconUrl?: string;
+}
+export declare const PLUGIN_TYPE_ARR: PluginType[];

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

@@ -0,0 +1,63 @@
+import { MonthlyQuotaName, StaticQuotaName } from "../../sdk";
+export declare enum BreakdownQuotaName {
+    ROW_QUERIES = "rowQueries",
+    DATASOURCE_QUERIES = "datasourceQueries",
+    AUTOMATIONS = "automations"
+}
+export declare const APP_QUOTA_NAMES: (StaticQuotaName | MonthlyQuotaName)[];
+export declare const BREAKDOWN_QUOTA_NAMES: MonthlyQuotaName[];
+export interface UsageBreakdown {
+    parent: MonthlyQuotaName;
+    values: {
+        [key: string]: number;
+    };
+}
+export declare type QuotaTriggers = {
+    [key: string]: string | undefined;
+};
+export interface StaticUsage {
+    [StaticQuotaName.APPS]: number;
+    [StaticQuotaName.PLUGINS]: number;
+    [StaticQuotaName.USERS]: number;
+    [StaticQuotaName.USER_GROUPS]: number;
+    [StaticQuotaName.ROWS]: number;
+    triggers: {
+        [key in StaticQuotaName]?: QuotaTriggers;
+    };
+}
+export interface MonthlyUsage {
+    [MonthlyQuotaName.QUERIES]: number;
+    [MonthlyQuotaName.AUTOMATIONS]: number;
+    [MonthlyQuotaName.DAY_PASSES]: number;
+    triggers: {
+        [key in MonthlyQuotaName]?: QuotaTriggers;
+    };
+    breakdown?: {
+        [key in BreakdownQuotaName]?: UsageBreakdown;
+    };
+}
+export interface BaseQuotaUsage {
+    usageQuota: StaticUsage;
+    monthly: {
+        [key: string]: MonthlyUsage;
+    };
+}
+export interface QuotaUsage extends BaseQuotaUsage {
+    _id: string;
+    _rev?: string;
+    quotaReset: string;
+    apps?: {
+        [key: string]: BaseQuotaUsage;
+    };
+}
+export declare type SetUsageValues = {
+    total: number;
+    app?: number;
+    breakdown?: number;
+    triggers?: QuotaTriggers;
+};
+export declare type UsageValues = {
+    total: number;
+    app?: number;
+    breakdown?: number;
+};

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

@@ -0,0 +1,21 @@
+import { Document } from "../document";
+export declare enum ScheduleType {
+    APP_BACKUP = "app_backup"
+}
+export declare enum ScheduleRepeatPeriod {
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly"
+}
+export interface Schedule extends Document {
+    type: ScheduleType;
+    name: string;
+    startDate: string;
+    repeat: ScheduleRepeatPeriod;
+    metadata: ScheduleMetadata;
+}
+export declare type ScheduleMetadata = AppBackupScheduleMetadata;
+export declare const isAppBackupMetadata: (type: ScheduleType, metadata: ScheduleMetadata) => metadata is AppBackupScheduleMetadata;
+export interface AppBackupScheduleMetadata {
+    apps: string[];
+}

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

@@ -0,0 +1,8 @@
+import { Document } from "../document";
+export interface Template extends Document {
+    ownerId?: string;
+    name?: string;
+    contents: string;
+    purpose: string;
+    type?: string;
+}

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

@@ -0,0 +1,74 @@
+import { Document } from "../document";
+export interface SSOProfileJson {
+    email?: string;
+    picture?: string;
+}
+export interface OAuth2 {
+    accessToken: string;
+    refreshToken?: string;
+}
+export declare enum SSOProviderType {
+    OIDC = "oidc",
+    GOOGLE = "google"
+}
+export interface UserSSO {
+    provider: string;
+    providerType: SSOProviderType;
+    oauth2?: OAuth2;
+    thirdPartyProfile?: SSOProfileJson;
+}
+export declare type SSOUser = User & UserSSO;
+export declare function isSSOUser(user: User): user is SSOUser;
+export interface User extends Document {
+    tenantId: string;
+    email: string;
+    userId?: string;
+    firstName?: string;
+    lastName?: string;
+    pictureUrl?: string;
+    forceResetPassword?: boolean;
+    roles: UserRoles;
+    builder?: {
+        global?: boolean;
+        apps?: string[];
+    };
+    admin?: {
+        global: boolean;
+    };
+    password?: string;
+    status?: UserStatus;
+    createdAt?: number;
+    dayPassRecordedAt?: string;
+    userGroups?: string[];
+    onboardedAt?: string;
+    scimInfo?: {
+        isSync: true;
+    } & Record<string, any>;
+}
+export declare enum UserStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive"
+}
+export interface UserRoles {
+    [key: string]: string;
+}
+export interface BuilderUser extends User {
+    builder: {
+        global?: boolean;
+        apps?: string[];
+    };
+}
+export interface AdminUser extends User {
+    admin: {
+        global: boolean;
+    };
+    builder: {
+        global: boolean;
+    };
+}
+export interface AdminOnlyUser extends User {
+    admin: {
+        global: boolean;
+    };
+}
+export declare function isUser(user: object): user is User;

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

@@ -0,0 +1,32 @@
+import { PaginationResponse } from "../../api";
+import { Document } from "../document";
+export interface UserGroup extends Document {
+    name: string;
+    icon: string;
+    color: string;
+    users?: GroupUser[];
+    roles?: UserGroupRoles;
+    createdAt?: number;
+    scimInfo?: {
+        externalId: string;
+        isSync: boolean;
+    };
+}
+export interface GroupUser {
+    _id: string;
+    email: string;
+}
+export interface UserGroupRoles {
+    [key: string]: string;
+}
+export interface SearchGroupRequest {
+}
+export interface SearchGroupResponse {
+    data: UserGroup[];
+}
+export interface SearchUserGroupResponse extends PaginationResponse {
+    users: {
+        _id: any;
+        email: any;
+    }[];
+}

package/dist/documents/index.d.ts

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

package/dist/documents/platform/accounts.d.ts

@@ -0,0 +1,4 @@
+import { Document } from "../document";
+export interface AccountMetadata extends Document {
+    email: string;
+}

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

@@ -0,0 +1,4 @@
+export * from "./info";
+export * from "./users";
+export * from "./accounts";
+export * from "./tenants";

package/dist/documents/platform/info.d.ts

@@ -0,0 +1,8 @@
+import { Document } from "../document";
+export interface GlobalInfo {
+}
+export interface Installation extends Document {
+    _id: string;
+    installId: string;
+    version: string;
+}

package/dist/documents/platform/tenants.d.ts

@@ -0,0 +1,4 @@
+import { Document } from "../document";
+export interface Tenants extends Document {
+    tenantIds: string[];
+}

package/dist/documents/platform/users.d.ts

@@ -0,0 +1,15 @@
+import { Document } from "../document";
+/**
+ * doc id is user email
+ */
+export interface PlatformUserByEmail extends Document {
+    tenantId: string;
+    userId: string;
+}
+/**
+ * doc id is userId
+ */
+export interface PlatformUserById extends Document {
+    tenantId: string;
+}
+export declare type PlatformUser = PlatformUserByEmail | PlatformUserById;