@budibase/types 2.9.19 → 2.9.21-alpha.0

package/dist/api/account/accounts.d.ts

@@ -0,0 +1,17 @@
+import { Account } from "../../documents";
+import { Hosting } from "../../sdk";
+export interface CreateAccountRequest {
+    email: string;
+    tenantId: string;
+    hosting: Hosting;
+    size: string;
+    profession: string;
+    tenantName?: string;
+    name?: string;
+    password: string;
+}
+export interface SearchAccountsRequest {
+    email?: string;
+    tenantId?: string;
+}
+export declare type SearchAccountsResponse = Account[];

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

@@ -0,0 +1,4 @@
+export * from "./accounts";
+export * from "./user";
+export * from "./license";
+export * from "./status";

package/dist/api/account/license.d.ts

@@ -0,0 +1,31 @@
+import { LicenseOverrides, QuotaUsage } from "../../documents";
+import { OfflineLicense, PlanType } from "../../sdk";
+import { ISO8601 } from "../../shared";
+export interface GetLicenseRequest {
+    quotaUsage?: QuotaUsage;
+    install: {
+        id: string;
+        tenantId: string;
+        version: string;
+    };
+}
+export interface QuotaTriggeredRequest {
+    percentage: number;
+    name: string;
+    resetDate?: string;
+}
+export interface LicenseActivateRequest {
+    installVersion?: string;
+}
+export interface UpdateLicenseRequest {
+    planType?: PlanType;
+    overrides?: LicenseOverrides;
+}
+export interface CreateOfflineLicenseRequest {
+    installationIdentifierBase64: string;
+    expireAt: ISO8601;
+}
+export interface GetOfflineLicenseResponse {
+    offlineLicenseToken: string;
+    license: OfflineLicense;
+}

package/dist/api/account/status.d.ts

@@ -0,0 +1,7 @@
+export interface HealthStatusResponse {
+    passing: boolean;
+    checks: {
+        login: boolean;
+        search: boolean;
+    };
+}

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

@@ -1,8 +1,7 @@
 export interface PostAccountUserActivity {
-  timestamp: number
+    timestamp: number;
 }
-
 export interface PostAccountUserActivityResponse {
-  userId: string
-  timestamp: number
+    userId: string;
+    timestamp: number;
 }

package/dist/api/index.d.ts

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

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

@@ -0,0 +1,9 @@
+export declare enum PingSource {
+    BUILDER = "builder",
+    APP = "app"
+}
+export interface AnalyticsPingRequest {
+    source: PingSource;
+    timezone: string;
+    embedded?: boolean;
+}

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

@@ -1,22 +1,18 @@
-import { AppBackupTrigger, AppBackupType } from "../../../documents"
-
+import { AppBackupTrigger, AppBackupType } from "../../../documents";
 export interface SearchAppBackupsRequest {
-  trigger: AppBackupTrigger
-  type: AppBackupType
-  startDate: string
-  endDate: string
-  page?: string
+    trigger: AppBackupTrigger;
+    type: AppBackupType;
+    startDate: string;
+    endDate: string;
+    page?: string;
 }
-
 export interface CreateAppBackupRequest {
-  name: string
+    name: string;
 }
-
 export interface CreateAppBackupResponse {
-  backupId: string
-  message: string
+    backupId: string;
+    message: string;
 }
-
 export interface UpdateAppBackupRequest {
-  name: string
+    name: string;
 }

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

@@ -1,37 +1,29 @@
-import { Datasource } from "../../../documents"
-
+import { Datasource } from "../../../documents";
 export interface CreateDatasourceResponse {
-  datasource: Datasource
-  error?: any
+    datasource: Datasource;
+    error?: any;
 }
-
 export interface UpdateDatasourceResponse {
-  datasource: Datasource
+    datasource: Datasource;
 }
-
 export interface CreateDatasourceRequest {
-  datasource: Datasource
-  fetchSchema?: boolean
-  tablesFilter: string[]
+    datasource: Datasource;
+    fetchSchema?: boolean;
+    tablesFilter: string[];
 }
-
 export interface VerifyDatasourceRequest {
-  datasource: Datasource
+    datasource: Datasource;
 }
-
 export interface VerifyDatasourceResponse {
-  connected: boolean
-  error?: string
+    connected: boolean;
+    error?: string;
 }
-
 export interface FetchDatasourceInfoRequest {
-  datasource: Datasource
+    datasource: Datasource;
 }
-
 export interface FetchDatasourceInfoResponse {
-  tableNames: string[]
+    tableNames: string[];
 }
-
 export interface UpdateDatasourceRequest extends Datasource {
-  datasource: Datasource
+    datasource: Datasource;
 }

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

@@ -0,0 +1,6 @@
+export * from "./backup";
+export * from "./datasource";
+export * from "./row";
+export * from "./view";
+export * from "./rows";
+export * from "./table";

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

@@ -0,0 +1,8 @@
+import { Row } from "../../../documents/app/row";
+export interface DeleteRows {
+    rows: (Row | string)[];
+}
+export interface DeleteRow {
+    _id: string;
+}
+export declare type DeleteRowRequest = DeleteRows | DeleteRow;

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

@@ -0,0 +1,16 @@
+import { SearchParams } from "../../../sdk";
+import { Row } from "../../../documents";
+export interface PatchRowRequest extends Row {
+    _id: string;
+    _rev: string;
+    tableId: string;
+}
+export interface PatchRowResponse extends Row {
+}
+export interface SearchRowRequest extends Omit<SearchParams, "tableId"> {
+}
+export interface SearchViewRowRequest extends Pick<SearchRowRequest, "sort" | "sortOrder" | "sortType" | "limit" | "bookmark" | "paginate"> {
+}
+export interface SearchRowResponse {
+    rows: any[];
+}

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

@@ -0,0 +1,12 @@
+import { Table, TableSchema, View, ViewV2 } from "../../../documents";
+interface ViewV2Response extends ViewV2 {
+    schema: TableSchema;
+}
+export declare type TableViewsResponse = {
+    [key: string]: View | ViewV2Response;
+};
+export interface TableResponse extends Table {
+    views?: TableViewsResponse;
+}
+export declare type FetchTablesResponse = TableResponse[];
+export {};

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

@@ -0,0 +1,10 @@
+import { ViewV2, UIFieldMetadata } from "../../../documents";
+export interface ViewResponse {
+    data: ViewV2;
+}
+export interface CreateViewRequest extends Omit<ViewV2, "version" | "id" | "columns" | "schemaUI"> {
+    schema?: Record<string, UIFieldMetadata>;
+}
+export interface UpdateViewRequest extends Omit<ViewV2, "columns" | "schemaUI"> {
+    schema?: Record<string, UIFieldMetadata>;
+}

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

@@ -0,0 +1,22 @@
+export interface LoginRequest {
+    username: string;
+    password: string;
+}
+export interface PasswordResetRequest {
+    email: string;
+}
+export interface PasswordResetUpdateRequest {
+    resetCode: string;
+    password: string;
+}
+export interface UpdateSelfRequest {
+    firstName?: string;
+    lastName?: string;
+    password?: string;
+    forceResetPassword?: boolean;
+    onboardedAt?: string;
+}
+export interface UpdateSelfResponse {
+    _id: string;
+    _rev: string;
+}

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

@@ -0,0 +1,11 @@
+export interface GetDiagnosticsResponse {
+    budibaseVersion: string;
+    hosting: string;
+    nodeVersion: string;
+    platform: string;
+    cpuArch: string;
+    cpuCores: number;
+    cpuInfo: string;
+    totalMemory: string;
+    uptime: string;
+}

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

@@ -0,0 +1,6 @@
+export interface APIError {
+    message: string;
+    status: number;
+    error?: any;
+    validationErrors?: any;
+}

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

@@ -0,0 +1,39 @@
+import { Event } from "../../../sdk";
+import { PaginationResponse, BasicPaginationRequest } from "../";
+import { User, App } from "../../../";
+export interface AuditLogSearchParams {
+    userIds?: string[];
+    appIds?: string[];
+    events?: Event[];
+    startDate?: string;
+    endDate?: string;
+    fullSearch?: string;
+    bookmark?: string;
+}
+export interface DownloadAuditLogsRequest extends AuditLogSearchParams {
+}
+export interface SearchAuditLogsRequest extends BasicPaginationRequest, AuditLogSearchParams {
+}
+export declare enum AuditLogResourceStatus {
+    DELETED = "deleted"
+}
+export declare type DeletedResourceInfo = {
+    _id: string;
+    status: AuditLogResourceStatus;
+    email?: string;
+    name?: string;
+};
+export interface AuditLogEnriched {
+    app?: App | DeletedResourceInfo;
+    user: User | DeletedResourceInfo;
+    event: Event;
+    timestamp: string;
+    name: string;
+    metadata: any;
+}
+export interface SearchAuditLogsResponse extends PaginationResponse {
+    data: AuditLogEnriched[];
+}
+export interface DefinitionsAuditLogsResponse {
+    events: Record<string, string>;
+}

package/{src/api/web/global/configs.ts → dist/api/web/global/configs.d.ts}

@@ -1,24 +1,20 @@
-import { SettingsConfig, SettingsInnerConfig } from "../../../documents"
-
+import { SettingsConfig, SettingsInnerConfig } from "../../../documents";
 /**
  * Settings that aren't stored in the database - enriched at runtime.
  */
 export interface PublicSettingsInnerConfig extends SettingsInnerConfig {
-  google: boolean
-  googleDatasourceConfigured: boolean
-  oidc: boolean
-  oidcCallbackUrl: string
-  googleCallbackUrl: string
+    google: boolean;
+    googleDatasourceConfigured: boolean;
+    oidc: boolean;
+    oidcCallbackUrl: string;
+    googleCallbackUrl: string;
 }
-
 export interface GetPublicSettingsResponse extends SettingsConfig {
-  config: PublicSettingsInnerConfig
+    config: PublicSettingsInnerConfig;
 }
-
 export interface PublicOIDCConfig {
-  logo?: string
-  name?: string
-  uuid?: string
+    logo?: string;
+    name?: string;
+    uuid?: string;
 }
-
-export type GetPublicOIDCConfigResponse = PublicOIDCConfig[]
+export declare type GetPublicOIDCConfigResponse = PublicOIDCConfig[];

package/{src/api/web/global/environmentVariables.ts → dist/api/web/global/environmentVariables.d.ts}

@@ -1,18 +1,15 @@
 export interface StatusEnvironmentVariableResponse {
-  encryptionKeyAvailable: boolean
+    encryptionKeyAvailable: boolean;
 }
-
 export interface CreateEnvironmentVariableRequest {
-  name: string
-  production: string
-  development: string
+    name: string;
+    production: string;
+    development: string;
 }
-
 export interface UpdateEnvironmentVariableRequest {
-  production: string
-  development: string
+    production: string;
+    development: string;
 }
-
 export interface GetEnvironmentVariablesResponse {
-  variables: string[]
+    variables: string[];
 }

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

@@ -0,0 +1,6 @@
+export declare enum EventPublishType {
+    ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable_upgrade_panel_opened"
+}
+export interface PostEventPublishRequest {
+    type: EventPublishType;
+}

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

@@ -0,0 +1,6 @@
+export * from "./environmentVariables";
+export * from "./auditLogs";
+export * from "./events";
+export * from "./configs";
+export * from "./scim";
+export * from "./license";

package/{src/api/web/global/license.ts → dist/api/web/global/license.d.ts}

@@ -1,25 +1,15 @@
-// LICENSE KEY
-
 export interface ActivateLicenseKeyRequest {
-  licenseKey: string
+    licenseKey: string;
 }
-
 export interface GetLicenseKeyResponse {
-  licenseKey: string
+    licenseKey: string;
 }
-
-// OFFLINE LICENSE
-
 export interface ActivateOfflineLicenseTokenRequest {
-  offlineLicenseToken: string
+    offlineLicenseToken: string;
 }
-
 export interface GetOfflineLicenseTokenResponse {
-  offlineLicenseToken: string
+    offlineLicenseToken: string;
 }
-
-// IDENTIFIER
-
 export interface GetOfflineIdentifierResponse {
-  identifierBase64: string
+    identifierBase64: string;
 }

package/dist/api/web/global/scim/groups.d.ts

@@ -0,0 +1,27 @@
+import { ScimResource, ScimMeta } from "scim-patch";
+import { ScimListResponse } from "./shared";
+export interface ScimGroupResponse extends ScimResource {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:Group"];
+    id: string;
+    externalId: string;
+    displayName: string;
+    meta: ScimMeta & {
+        resourceType: "Group";
+    };
+    members?: {
+        value: string;
+    }[];
+}
+export interface ScimCreateGroupRequest {
+    schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:Group",
+        "http://schemas.microsoft.com/2006/11/ResourceManagement/ADSCIM/2.0/Group"
+    ];
+    externalId: string;
+    displayName: string;
+    meta: ScimMeta & {
+        resourceType: "Group";
+    };
+}
+export interface ScimGroupListResponse extends ScimListResponse<ScimGroupResponse> {
+}

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

@@ -0,0 +1,3 @@
+export * from "./users";
+export * from "./groups";
+export * from "./shared";

package/dist/api/web/global/scim/shared.d.ts

@@ -0,0 +1,12 @@
+import { ScimPatchOperation } from "scim-patch";
+export interface ScimListResponse<T> {
+    schemas: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"];
+    totalResults: number;
+    Resources: T[];
+    startIndex: number;
+    itemsPerPage: number;
+}
+export interface ScimUpdateRequest {
+    schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"];
+    Operations: ScimPatchOperation[];
+}

package/dist/api/web/global/scim/users.d.ts

@@ -0,0 +1,48 @@
+import { ScimResource, ScimMeta } from "scim-patch";
+import { ScimListResponse } from "./shared";
+declare type BooleanString = boolean | "True" | "true" | "False" | "false";
+declare type Emails = {
+    value: string;
+    type: "work";
+    primary: boolean;
+}[];
+export interface ScimUserResponse extends ScimResource {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"];
+    id: string;
+    externalId: string;
+    meta: ScimMeta & {
+        resourceType: "User";
+    };
+    userName: string;
+    displayName?: string;
+    name?: {
+        formatted?: string;
+        familyName?: string;
+        givenName?: string;
+    };
+    active: BooleanString;
+    emails?: Emails;
+}
+export interface ScimCreateUserRequest {
+    schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:User",
+        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+    ];
+    externalId: string;
+    userName: string;
+    active: BooleanString;
+    emails?: Emails;
+    meta: {
+        resourceType: "User";
+    };
+    displayName?: string;
+    name?: {
+        formatted: string;
+        familyName: string;
+        givenName: string;
+    };
+    roles: [];
+}
+export interface ScimUserListResponse extends ScimListResponse<ScimUserResponse> {
+}
+export {};

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

@@ -0,0 +1,11 @@
+export * from "./analytics";
+export * from "./auth";
+export * from "./user";
+export * from "./errors";
+export * from "./debug";
+export * from "./schedule";
+export * from "./system";
+export * from "./app";
+export * from "./global";
+export * from "./pagination";
+export * from "./searchFilter";

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

@@ -0,0 +1,23 @@
+export declare enum SortOrder {
+    ASCENDING = "ascending",
+    DESCENDING = "descending"
+}
+export declare enum SortType {
+    STRING = "string",
+    number = "number"
+}
+export interface BasicPaginationRequest {
+    bookmark?: string;
+}
+export interface PaginationRequest extends BasicPaginationRequest {
+    limit?: number;
+    sort?: {
+        order: SortOrder;
+        column: string;
+        type: SortType;
+    };
+}
+export interface PaginationResponse {
+    bookmark: string | undefined;
+    hasNextPage: boolean;
+}

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

@@ -0,0 +1,10 @@
+import { ScheduleMetadata, ScheduleRepeatPeriod, ScheduleType } from "../../documents";
+export interface CreateScheduleRequest {
+    type: ScheduleType;
+    name: string;
+    startDate: string;
+    repeat: ScheduleRepeatPeriod;
+    metadata: ScheduleMetadata;
+}
+export interface UpdateScheduleRequest extends CreateScheduleRequest {
+}

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

@@ -0,0 +1,48 @@
+import { FieldType } from "../../documents";
+export declare type SearchFilter = {
+    operator: keyof SearchQuery;
+    field: string;
+    type?: FieldType;
+    value: any;
+    externalType?: string;
+};
+export declare type SearchQuery = {
+    allOr?: boolean;
+    string?: {
+        [key: string]: string;
+    };
+    fuzzy?: {
+        [key: string]: string;
+    };
+    range?: {
+        [key: string]: {
+            high: number | string;
+            low: number | string;
+        };
+    };
+    equal?: {
+        [key: string]: any;
+    };
+    notEqual?: {
+        [key: string]: any;
+    };
+    empty?: {
+        [key: string]: any;
+    };
+    notEmpty?: {
+        [key: string]: any;
+    };
+    oneOf?: {
+        [key: string]: any[];
+    };
+    contains?: {
+        [key: string]: any[];
+    };
+    notContains?: {
+        [key: string]: any[];
+    };
+    containsAny?: {
+        [key: string]: any[];
+    };
+};
+export declare type SearchQueryFields = Omit<SearchQuery, "allOr">;

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

@@ -0,0 +1,8 @@
+export interface GetEnvironmentResponse {
+    multiTenancy: boolean;
+    cloud: boolean;
+    accountPortalUrl: string;
+    baseUrl: string;
+    disableAccountPortal: boolean;
+    isDev: boolean;
+}

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

@@ -0,0 +1 @@
+export * from "./environment";