@budibase/types 2.3.19 → 2.3.21-alpha.0

package/src/sdk/events/identification.ts

@@ -34,6 +34,11 @@ export enum IdentityType {
   INSTALLATION = "installation",
 }
 
+export interface HostInfo {
+  ipAddress?: string
+  userAgent?: string
+}
+
 export interface Identity {
   id: string
   type: IdentityType
@@ -41,6 +46,7 @@ export interface Identity {
   environment: string
   installationId?: string
   tenantId?: string
+  hostInfo?: HostInfo
 }
 
 export interface UserIdentity extends Identity {

package/src/sdk/events/index.ts

@@ -22,3 +22,4 @@ export * from "./userGroup"
 export * from "./plugin"
 export * from "./backup"
 export * from "./environmentVariable"
+export * from "./auditLog"

package/src/sdk/events/screen.ts

@@ -4,10 +4,16 @@ export interface ScreenCreatedEvent extends BaseEvent {
   screenId: string
   layoutId?: string
   roleId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface ScreenDeletedEvent extends BaseEvent {
   screenId: string
   layoutId?: string
   roleId: string
+  audited: {
+    name: string
+  }
 }

package/src/sdk/events/table.ts

@@ -2,21 +2,36 @@ import { BaseEvent, TableExportFormat } from "./event"
 
 export interface TableCreatedEvent extends BaseEvent {
   tableId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface TableUpdatedEvent extends BaseEvent {
   tableId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface TableDeletedEvent extends BaseEvent {
   tableId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface TableExportedEvent extends BaseEvent {
   tableId: string
   format: TableExportFormat
+  audited: {
+    name: string
+  }
 }
 
 export interface TableImportedEvent extends BaseEvent {
   tableId: string
+  audited: {
+    name: string
+  }
 }

package/src/sdk/events/user.ts

@@ -2,47 +2,84 @@ import { BaseEvent } from "./event"
 
 export interface UserCreatedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserUpdatedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserDeletedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserOnboardingEvent extends BaseEvent {
   userId: string
   step?: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPermissionAssignedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPermissionRemovedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
-export interface UserInvitedEvent extends BaseEvent {}
+export interface UserInvitedEvent extends BaseEvent {
+  audited: {
+    email: string
+  }
+}
 
 export interface UserInviteAcceptedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPasswordForceResetEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPasswordUpdatedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPasswordResetRequestedEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }
 
 export interface UserPasswordResetEvent extends BaseEvent {
   userId: string
+  audited: {
+    email: string
+  }
 }

package/src/sdk/events/userGroup.ts

@@ -2,27 +2,50 @@ import { BaseEvent } from "./event"
 
 export interface GroupCreatedEvent extends BaseEvent {
   groupId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface GroupUpdatedEvent extends BaseEvent {
   groupId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface GroupDeletedEvent extends BaseEvent {
   groupId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface GroupUsersAddedEvent extends BaseEvent {
   count: number
   groupId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface GroupUsersDeletedEvent extends BaseEvent {
   count: number
   groupId: string
+  audited: {
+    name: string
+  }
 }
 
 export interface GroupAddedOnboardingEvent extends BaseEvent {
   groupId: string
   onboarding: boolean
 }
+
+export interface GroupPermissionsEditedEvent extends BaseEvent {
+  permissions: Record<string, string>
+  groupId: string
+  audited: {
+    name: string
+  }
+}

package/src/sdk/index.ts

@@ -12,3 +12,7 @@ export * from "./db"
 export * from "./middleware"
 export * from "./featureFlag"
 export * from "./environmentVariables"
+export * from "./auditLogs"
+export * from "./sso"
+export * from "./user"
+export * from "./cli"

package/src/sdk/licensing/feature.ts

@@ -2,4 +2,6 @@ export enum Feature {
   USER_GROUPS = "userGroups",
   APP_BACKUPS = "appBackups",
   ENVIRONMENT_VARIABLES = "environmentVariables",
+  AUDIT_LOGS = "auditLogs",
+  ENFORCEABLE_SSO = "enforceableSSO",
 }

package/src/sdk/locks.ts

@@ -12,6 +12,7 @@ export enum LockName {
   MIGRATIONS = "migrations",
   TRIGGER_QUOTA = "trigger_quota",
   SYNC_ACCOUNT_LICENSE = "sync_account_license",
+  UPDATE_TENANTS_DOC = "update_tenants_doc",
 }
 
 export interface LockOptions {

package/src/sdk/sso.ts

@@ -0,0 +1,37 @@
+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 type SaveSSOUserFunction = (
+  user: SSOUser,
+  opts: SaveUserOpts
+) => Promise<User>

package/src/sdk/user.ts

@@ -0,0 +1,12 @@
+export interface UpdateSelf {
+  firstName?: string
+  lastName?: string
+  password?: string
+  forceResetPassword?: boolean
+}
+
+export interface SaveUserOpts {
+  hashPassword?: boolean
+  requirePassword?: boolean
+  currentUserId?: string
+}