@budibase/types 2.9.19 → 2.9.20

package/dist/sdk/locks.d.ts

@@ -0,0 +1,47 @@
+import Redlock from "redlock";
+export declare enum LockType {
+    /**
+     * If this lock is already held the attempted operation will not be performed.
+     * No retries will take place and no error will be thrown.
+     */
+    TRY_ONCE = "try_once",
+    TRY_TWICE = "try_twice",
+    DEFAULT = "default",
+    DELAY_500 = "delay_500",
+    CUSTOM = "custom"
+}
+export declare enum LockName {
+    MIGRATIONS = "migrations",
+    TRIGGER_QUOTA = "trigger_quota",
+    SYNC_ACCOUNT_LICENSE = "sync_account_license",
+    UPDATE_TENANTS_DOC = "update_tenants_doc",
+    PERSIST_WRITETHROUGH = "persist_writethrough",
+    QUOTA_USAGE_EVENT = "quota_usage_event"
+}
+export interface LockOptions {
+    /**
+     * The lock type determines which client to use
+     */
+    type: LockType;
+    /**
+     * The custom options to use when creating the redlock instance
+     * type must be set to custom for the options to be applied
+     */
+    customOptions?: Redlock.Options;
+    /**
+     * The name for the lock
+     */
+    name: LockName;
+    /**
+     * The ttl to auto-expire the lock if not unlocked manually
+     */
+    ttl: number;
+    /**
+     * The individual resource to lock. This is useful for locking around very specific identifiers, e.g. a document that is prone to conflicts
+     */
+    resource?: string;
+    /**
+     * This is a system-wide lock - don't use tenancy in lock key
+     */
+    systemLock?: boolean;
+}

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

@@ -0,0 +1,2 @@
+export * from "./matchers";
+export * from "./tenancy";

package/dist/sdk/middleware/matchers.d.ts

@@ -0,0 +1,21 @@
+export interface EndpointMatcher {
+    /**
+     * The HTTP Path. e.g. /api/things/:thingId
+     */
+    route: string;
+    /**
+     * The HTTP Verb. e.g. GET, POST, etc.
+     * ALL is also accepted to cover all verbs.
+     */
+    method: string;
+    /**
+     * The route must match exactly - not just begins with
+     */
+    strict?: boolean;
+}
+export interface RegexMatcher {
+    regex: RegExp;
+    method: string;
+    strict: boolean;
+    route: string;
+}

package/dist/sdk/middleware/tenancy.d.ts

@@ -0,0 +1,12 @@
+export interface GetTenantIdOptions {
+    allowNoTenant?: boolean;
+    excludeStrategies?: TenantResolutionStrategy[];
+    includeStrategies?: TenantResolutionStrategy[];
+}
+export declare enum TenantResolutionStrategy {
+    USER = "user",
+    HEADER = "header",
+    QUERY = "query",
+    SUBDOMAIN = "subdomain",
+    PATH = "path"
+}

package/dist/sdk/migrations.d.ts

@@ -0,0 +1,46 @@
+export interface Migration extends MigrationDefinition {
+    appOpts?: object;
+    fn: Function;
+    silent?: boolean;
+    preventRetry?: boolean;
+}
+export declare enum MigrationType {
+    GLOBAL = "global",
+    APP = "app",
+    INSTALLATION = "installation"
+}
+export interface MigrationNoOpOptions {
+    type: MigrationType;
+    tenantId: string;
+    appId?: string;
+}
+/**
+ * e.g.
+ * {
+ *   tenantIds: ['bb'],
+ *   force: {
+ *    global: ['quota_1']
+ *   }
+ * }
+ */
+export interface MigrationOptions {
+    tenantIds?: string[];
+    force?: {
+        [type: string]: string[];
+    };
+    noOp?: MigrationNoOpOptions;
+}
+export declare enum MigrationName {
+    USER_EMAIL_VIEW_CASING = "user_email_view_casing",
+    APP_URLS = "app_urls",
+    EVENT_APP_BACKFILL = "event_app_backfill",
+    EVENT_GLOBAL_BACKFILL = "event_global_backfill",
+    EVENT_INSTALLATION_BACKFILL = "event_installation_backfill",
+    GLOBAL_INFO_SYNC_USERS = "global_info_sync_users",
+    TABLE_SETTINGS_LINKS_TO_ACTIONS = "table_settings_links_to_actions",
+    SYNC_QUOTAS = "sync_quotas_1"
+}
+export interface MigrationDefinition {
+    type: MigrationType;
+    name: MigrationName;
+}

package/dist/sdk/permissions.d.ts

@@ -0,0 +1,17 @@
+export declare enum PermissionLevel {
+    READ = "read",
+    WRITE = "write",
+    EXECUTE = "execute",
+    ADMIN = "admin"
+}
+export declare enum PermissionType {
+    APP = "app",
+    TABLE = "table",
+    USER = "user",
+    AUTOMATION = "automation",
+    WEBHOOK = "webhook",
+    BUILDER = "builder",
+    GLOBAL_BUILDER = "globalBuilder",
+    VIEW = "view",
+    QUERY = "query"
+}

package/dist/sdk/search.d.ts

@@ -0,0 +1,94 @@
+import { Operation, SortDirection } from "./datasources";
+import { Row, Table } from "../documents";
+import { SortType } from "../api";
+export interface SearchFilters {
+    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[] | any;
+    };
+    notContains?: {
+        [key: string]: any[];
+    };
+    containsAny?: {
+        [key: string]: any[];
+    };
+}
+export interface SortJson {
+    [key: string]: {
+        direction: SortDirection;
+        type?: SortType;
+    };
+}
+export interface PaginationJson {
+    limit: number;
+    page?: string | number;
+}
+export interface RenameColumn {
+    old: string;
+    updated: string;
+}
+export interface RelationshipsJson {
+    through?: string;
+    from?: string;
+    to?: string;
+    fromPrimary?: string;
+    toPrimary?: string;
+    tableName: string;
+    column: string;
+}
+export interface QueryJson {
+    endpoint: {
+        datasourceId: string;
+        entityId: string;
+        operation: Operation;
+        schema?: string;
+    };
+    resource?: {
+        fields: string[];
+    };
+    filters?: SearchFilters;
+    sort?: SortJson;
+    paginate?: PaginationJson;
+    body?: Row | Row[];
+    table?: Table;
+    meta?: {
+        table?: Table;
+        tables?: Record<string, Table>;
+        renamed?: RenameColumn;
+    };
+    extra?: {
+        idFilter?: SearchFilters;
+    };
+    relationships?: RelationshipsJson[];
+}
+export interface SqlQuery {
+    sql: string;
+    bindings?: string[];
+}

package/dist/sdk/sso.d.ts

@@ -0,0 +1,24 @@
+import { OAuth2, SSOProfileJson, SSOProviderType, SSOUser, User } from "../documents";
+import { SaveUserOpts } from "./user";
+export interface JwtClaims {
+    preferred_username?: string;
+    email?: string;
+}
+export interface SSOAuthDetails {
+    oauth2: OAuth2;
+    provider: string;
+    providerType: SSOProviderType;
+    userId: string;
+    email?: string;
+    profile?: SSOProfile;
+}
+export interface SSOProfile {
+    id: string;
+    name?: {
+        givenName?: string;
+        familyName?: string;
+    };
+    _json: SSOProfileJson;
+    provider?: string;
+}
+export declare type SaveSSOUserFunction = (user: SSOUser, opts: SaveUserOpts) => Promise<User>;

package/dist/sdk/user.d.ts

@@ -0,0 +1,5 @@
+export interface SaveUserOpts {
+    hashPassword?: boolean;
+    requirePassword?: boolean;
+    currentUserId?: string;
+}

package/dist/sdk/websocket.d.ts

@@ -0,0 +1,9 @@
+export interface SocketSession {
+    _id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    sessionId: string;
+    room?: string;
+    connectedAt: number;
+}

package/dist/shared/index.d.ts

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

package/dist/shared/typeUtils.d.ts

@@ -0,0 +1,7 @@
+export declare type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export declare type ISO8601 = string;
+export declare type RequiredKeys<T> = {
+    [K in keyof Required<T>]: T[K];
+};

package/package.json

@@ -1,15 +1,9 @@
 {
   "name": "@budibase/types",
-  "version": "2.9.19",
+  "version": "2.9.20",
   "description": "Budibase types",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./src/index.ts"
-    }
-  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "author": "Budibase",
   "license": "GPL-3.0",
   "scripts": {
@@ -35,5 +29,5 @@
   "dependencies": {
     "scim-patch": "^0.7.0"
   },
-  "gitHead": "1e299bc55448c482ae317151dd4fdddefcca558c"
+  "gitHead": "11d253164ee6128d5c472c7994a9119f415a5e36"
 }

package/src/api/account/accounts.ts

@@ -1,22 +0,0 @@
-import { Account } from "../../documents"
-import { Hosting } from "../../sdk"
-
-export interface CreateAccountRequest {
-  email: string
-  tenantId: string
-  hosting: Hosting
-  size: string
-  profession: string
-  // optional fields
-  tenantName?: string
-  name?: string
-  password: string
-}
-
-export interface SearchAccountsRequest {
-  // one or the other - not both
-  email?: string
-  tenantId?: string
-}
-
-export type SearchAccountsResponse = Account[]

package/src/api/account/index.ts

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

package/src/api/account/license.ts

@@ -1,39 +0,0 @@
-import { LicenseOverrides, QuotaUsage } from "../../documents"
-import { OfflineLicense, PlanType } from "../../sdk"
-import { ISO8601 } from "../../shared"
-
-export interface GetLicenseRequest {
-  // All fields should be optional to cater for
-  // historical versions of budibase
-  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/src/api/account/status.ts

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

package/src/api/index.ts

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

package/src/api/web/analytics.ts

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

package/src/api/web/app/index.ts

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

package/src/api/web/app/row.ts

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

package/src/api/web/app/rows.ts

@@ -1,13 +0,0 @@
-import { Row } from "../../../documents"
-
-export interface PatchRowRequest extends Row {
-  _id: string
-  _rev: string
-  tableId: string
-}
-
-export interface PatchRowResponse extends Row {}
-
-export interface SearchResponse {
-  rows: any[]
-}

package/src/api/web/app/table.ts

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

package/src/api/web/app/view.ts

@@ -1,15 +0,0 @@
-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/src/api/web/auth.ts

@@ -1,26 +0,0 @@
-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/src/api/web/debug.ts

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

package/src/api/web/errors.ts

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

package/src/api/web/global/auditLogs.ts

@@ -1,51 +0,0 @@
-import { Event, AuditedEventFriendlyName } from "../../../sdk"
-import {
-  PaginationResponse,
-  PaginationRequest,
-  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 enum AuditLogResourceStatus {
-  DELETED = "deleted",
-}
-
-export 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/events.ts

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

package/src/api/web/global/index.ts

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

package/src/api/web/global/scim/groups.ts

@@ -1,30 +0,0 @@
-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/src/api/web/global/scim/index.ts

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

package/src/api/web/global/scim/shared.ts

@@ -1,14 +0,0 @@
-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[]
-}