@budibase/types 2.2.26 → 2.2.27-alpha.1

package/src/sdk/events/auth.ts

@@ -1,7 +1,8 @@
 import { BaseEvent } from "./event"
+import { ConfigType } from "../../documents"
 
 export type LoginSource = "local" | "google" | "oidc" | "google-internal"
-export type SSOType = "oidc" | "google"
+export type SSOType = ConfigType.OIDC | ConfigType.GOOGLE
 
 export interface LoginEvent extends BaseEvent {
   userId: string

package/src/sdk/events/environmentVariable.ts

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

package/src/sdk/events/event.ts

@@ -6,6 +6,9 @@ export enum Event {
   USER_UPDATED = "user:updated",
   USER_DELETED = "user:deleted",
 
+  // USER / ONBOARDING
+  USER_ONBOARDING_COMPLETE = "user:onboarding:complete",
+
   // USER / PERMISSIONS
   USER_PERMISSION_ADMIN_ASSIGNED = "user:admin:assigned",
   USER_PERMISSION_ADMIN_REMOVED = "user:admin:removed",
@@ -172,6 +175,11 @@ export enum Event {
   // BACKUP
   APP_BACKUP_RESTORED = "app:backup:restored",
   APP_BACKUP_TRIGGERED = "app:backup:triggered",
+
+  // ENVIRONMENT VARIABLE
+  ENVIRONMENT_VARIABLE_CREATED = "environment_variable:created",
+  ENVIRONMENT_VARIABLE_DELETED = "environment_variable:deleted",
+  ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable:upgrade_panel_opened",
 }
 
 // properties added at the final stage of the event pipeline
@@ -185,6 +193,4 @@ export interface BaseEvent {
   hosting?: Hosting
 }
 
-export type RowImportFormat = "csv"
 export type TableExportFormat = "json" | "csv"
-export type TableImportFormat = "csv"

package/src/sdk/events/index.ts

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

package/src/sdk/events/rows.ts

@@ -1,8 +1,7 @@
-import { BaseEvent, RowImportFormat } from "./event"
+import { BaseEvent } from "./event"
 
 export interface RowsImportedEvent extends BaseEvent {
   tableId: string
-  format: RowImportFormat
   count: number
 }
 

package/src/sdk/events/table.ts

@@ -1,4 +1,4 @@
-import { BaseEvent, TableExportFormat, TableImportFormat } from "./event"
+import { BaseEvent, TableExportFormat } from "./event"
 
 export interface TableCreatedEvent extends BaseEvent {
   tableId: string
@@ -19,5 +19,4 @@ export interface TableExportedEvent extends BaseEvent {
 
 export interface TableImportedEvent extends BaseEvent {
   tableId: string
-  format: TableImportFormat
 }

package/src/sdk/events/user.ts

@@ -12,6 +12,11 @@ export interface UserDeletedEvent extends BaseEvent {
   userId: string
 }
 
+export interface UserOnboardingEvent extends BaseEvent {
+  userId: string
+  step?: string
+}
+
 export interface UserPermissionAssignedEvent extends BaseEvent {
   userId: string
 }

package/src/sdk/index.ts

@@ -11,3 +11,4 @@ export * from "./locks"
 export * from "./db"
 export * from "./middleware"
 export * from "./featureFlag"
+export * from "./environmentVariables"

package/src/sdk/koa.ts

@@ -1,6 +1,7 @@
 import { Context, Request } from "koa"
 import { User, Role, UserRoles, Account } from "../documents"
 import { FeatureFlag, License } from "../sdk"
+import { Files } from "formidable"
 
 export interface ContextUser extends Omit<User, "roles"> {
   globalId?: string
@@ -15,12 +16,34 @@ export interface ContextUser extends Omit<User, "roles"> {
   account?: Account
 }
 
-export interface BBRequest extends Request {
-  body: any
-  files?: any
+/**
+ * Add support for koa-body in context.
+ */
+export interface BBRequest<RequestBody> extends Request {
+  body: RequestBody
+  files?: Files
 }
 
-export interface BBContext extends Context {
-  request: BBRequest
+/**
+ * Basic context with no user.
+ */
+export interface Ctx<RequestBody = any, ResponseBody = any> extends Context {
+  request: BBRequest<RequestBody>
+  body: ResponseBody
+}
+
+/**
+ * Authenticated context.
+ */
+export interface UserCtx<RequestBody = any, ResponseBody = any>
+  extends Ctx<RequestBody, ResponseBody> {
+  user: ContextUser
+}
+
+/**
+ * @deprecated: Use UserCtx / Ctx appropriately
+ * Authenticated context.
+ */
+export interface BBContext extends Ctx {
   user?: ContextUser
 }

package/src/sdk/licensing/feature.ts

@@ -1,4 +1,5 @@
 export enum Feature {
   USER_GROUPS = "userGroups",
   APP_BACKUPS = "appBackups",
+  ENVIRONMENT_VARIABLES = "environmentVariables",
 }