@budibase/types 3.2.25 → 3.2.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/web/auth.d.ts +13 -0
- package/dist/api/web/global/configs.d.ts +29 -1
- package/dist/api/web/global/email.d.ts +26 -0
- package/dist/api/web/global/index.d.ts +4 -0
- package/dist/api/web/global/license.d.ts +3 -0
- package/dist/api/web/global/role.d.ts +15 -0
- package/dist/api/web/global/self.d.ts +11 -0
- package/dist/api/web/global/template.d.ts +26 -0
- package/dist/api/web/system/account.d.ts +5 -0
- package/dist/api/web/system/environment.d.ts +7 -2
- package/dist/api/web/system/index.d.ts +5 -0
- package/dist/api/web/system/log.d.ts +1 -0
- package/dist/api/web/system/migration.d.ts +4 -0
- package/dist/api/web/system/restore.d.ts +3 -0
- package/dist/api/web/system/tenant.d.ts +3 -0
- package/dist/api/web/user.d.ts +50 -1
- package/dist/documents/global/devInfo.d.ts +5 -0
- package/dist/documents/global/index.d.ts +1 -0
- package/dist/index.js +19 -1
- package/dist/index.js.map +4 -4
- package/dist/index.js.meta.json +1 -1
- package/dist/sdk/db.d.ts +1 -1
- package/dist/sdk/events/event.d.ts +3 -1
- package/dist/sdk/events/index.d.ts +1 -0
- package/dist/sdk/events/rowAction.d.ts +5 -0
- package/dist/sdk/events/table.d.ts +3 -0
- package/dist/sdk/events/view.d.ts +9 -2
- package/dist/sdk/migrations.d.ts +2 -1
- package/package.json +3 -4
- package/dist/tsconfig.tsbuildinfo +0 -1
package/dist/api/web/auth.d.ts
CHANGED
|
@@ -2,13 +2,26 @@ export interface LoginRequest {
|
|
|
2
2
|
username: string;
|
|
3
3
|
password: string;
|
|
4
4
|
}
|
|
5
|
+
export interface LogoutResponse {
|
|
6
|
+
message: string;
|
|
7
|
+
}
|
|
8
|
+
export interface SetInitInfoRequest extends Record<string, any> {
|
|
9
|
+
}
|
|
10
|
+
export interface GetInitInfoResponse extends Record<string, any> {
|
|
11
|
+
}
|
|
5
12
|
export interface PasswordResetRequest {
|
|
6
13
|
email: string;
|
|
7
14
|
}
|
|
15
|
+
export interface PasswordResetResponse {
|
|
16
|
+
message: string;
|
|
17
|
+
}
|
|
8
18
|
export interface PasswordResetUpdateRequest {
|
|
9
19
|
resetCode: string;
|
|
10
20
|
password: string;
|
|
11
21
|
}
|
|
22
|
+
export interface PasswordResetUpdateResponse {
|
|
23
|
+
message: string;
|
|
24
|
+
}
|
|
12
25
|
export interface UpdateSelfRequest {
|
|
13
26
|
firstName?: string;
|
|
14
27
|
lastName?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { SettingsConfig, SettingsInnerConfig } from "../../../documents";
|
|
1
|
+
import { Config, ConfigType, SettingsBrandingConfig, SettingsConfig, SettingsInnerConfig } from "../../../documents";
|
|
2
2
|
/**
|
|
3
3
|
* Settings that aren't stored in the database - enriched at runtime.
|
|
4
4
|
*/
|
|
@@ -18,3 +18,31 @@ export interface PublicOIDCConfig {
|
|
|
18
18
|
uuid?: string;
|
|
19
19
|
}
|
|
20
20
|
export type GetPublicOIDCConfigResponse = PublicOIDCConfig[];
|
|
21
|
+
export interface SaveConfigRequest extends Config {
|
|
22
|
+
}
|
|
23
|
+
export interface SaveConfigResponse {
|
|
24
|
+
type: ConfigType;
|
|
25
|
+
_id: string;
|
|
26
|
+
_rev: string;
|
|
27
|
+
}
|
|
28
|
+
export interface DeleteConfigResponse {
|
|
29
|
+
message: string;
|
|
30
|
+
}
|
|
31
|
+
interface ChecklistItem {
|
|
32
|
+
checked: boolean;
|
|
33
|
+
label: string;
|
|
34
|
+
link: string;
|
|
35
|
+
}
|
|
36
|
+
export interface ConfigChecklistResponse {
|
|
37
|
+
apps: ChecklistItem;
|
|
38
|
+
smtp: ChecklistItem;
|
|
39
|
+
adminUser: ChecklistItem;
|
|
40
|
+
sso: ChecklistItem;
|
|
41
|
+
branding: SettingsBrandingConfig;
|
|
42
|
+
}
|
|
43
|
+
export type FindConfigResponse = Config | {};
|
|
44
|
+
export interface UploadConfigFileResponse {
|
|
45
|
+
message: string;
|
|
46
|
+
url: string;
|
|
47
|
+
}
|
|
48
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { EmailAttachment, EmailInvite } from "../../../documents";
|
|
2
|
+
export declare enum EmailTemplatePurpose {
|
|
3
|
+
CORE = "core",
|
|
4
|
+
BASE = "base",
|
|
5
|
+
PASSWORD_RECOVERY = "password_recovery",
|
|
6
|
+
INVITATION = "invitation",
|
|
7
|
+
WELCOME = "welcome",
|
|
8
|
+
CUSTOM = "custom"
|
|
9
|
+
}
|
|
10
|
+
export interface SendEmailRequest {
|
|
11
|
+
workspaceId?: string;
|
|
12
|
+
email: string;
|
|
13
|
+
userId: string;
|
|
14
|
+
purpose: EmailTemplatePurpose;
|
|
15
|
+
contents?: string;
|
|
16
|
+
from?: string;
|
|
17
|
+
subject: string;
|
|
18
|
+
cc?: boolean;
|
|
19
|
+
bcc?: boolean;
|
|
20
|
+
automation?: boolean;
|
|
21
|
+
invite?: EmailInvite;
|
|
22
|
+
attachments?: EmailAttachment[];
|
|
23
|
+
}
|
|
24
|
+
export interface SendEmailResponse extends Record<string, any> {
|
|
25
|
+
message: string;
|
|
26
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { QuotaUsage } from "../../../documents";
|
|
1
2
|
export interface ActivateLicenseKeyRequest {
|
|
2
3
|
licenseKey: string;
|
|
3
4
|
}
|
|
@@ -13,3 +14,5 @@ export interface GetOfflineLicenseTokenResponse {
|
|
|
13
14
|
export interface GetOfflineIdentifierResponse {
|
|
14
15
|
identifierBase64: string;
|
|
15
16
|
}
|
|
17
|
+
export interface GetQuotaUsageResponse extends QuotaUsage {
|
|
18
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Role } from "../../../documents";
|
|
2
|
+
interface GlobalRoleResponse {
|
|
3
|
+
roles: Role[];
|
|
4
|
+
name: string;
|
|
5
|
+
version: string;
|
|
6
|
+
url?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface FetchGlobalRolesResponse extends Record<string, GlobalRoleResponse> {
|
|
9
|
+
}
|
|
10
|
+
export interface FindGlobalRoleResponse extends GlobalRoleResponse {
|
|
11
|
+
}
|
|
12
|
+
export interface RemoveAppRoleResponse {
|
|
13
|
+
message: string;
|
|
14
|
+
}
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DevInfo, User } from "../../../documents";
|
|
2
|
+
export interface GenerateAPIKeyRequest {
|
|
3
|
+
userId: string;
|
|
4
|
+
}
|
|
5
|
+
export interface GenerateAPIKeyResponse extends DevInfo {
|
|
6
|
+
}
|
|
7
|
+
export interface FetchAPIKeyResponse extends DevInfo {
|
|
8
|
+
}
|
|
9
|
+
export interface GetGlobalSelfResponse extends User {
|
|
10
|
+
flags?: Record<string, string>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Template } from "../../../documents";
|
|
2
|
+
export interface GlobalTemplateDefinition {
|
|
3
|
+
name: string;
|
|
4
|
+
description: string;
|
|
5
|
+
category: string;
|
|
6
|
+
}
|
|
7
|
+
export interface GlobalTemplateBinding {
|
|
8
|
+
name: string;
|
|
9
|
+
description: string;
|
|
10
|
+
}
|
|
11
|
+
export interface FetchGlobalTemplateDefinitionResponse {
|
|
12
|
+
info: Record<string, GlobalTemplateDefinition>;
|
|
13
|
+
bindings: Record<string, GlobalTemplateBinding[]>;
|
|
14
|
+
}
|
|
15
|
+
export interface SaveGlobalTemplateRequest extends Template {
|
|
16
|
+
}
|
|
17
|
+
export interface SaveGlobalTemplateResponse extends Template {
|
|
18
|
+
}
|
|
19
|
+
export type FetchGlobalTemplateResponse = Template[];
|
|
20
|
+
export type FetchGlobalTemplateByTypeResponse = Template[];
|
|
21
|
+
export type FetchGlobalTemplateByOwnerIDResponse = Template[];
|
|
22
|
+
export interface FindGlobalTemplateResponse extends Template {
|
|
23
|
+
}
|
|
24
|
+
export interface DeleteGlobalTemplateResponse {
|
|
25
|
+
message: string;
|
|
26
|
+
}
|
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
export interface GetEnvironmentResponse {
|
|
2
2
|
multiTenancy: boolean;
|
|
3
|
+
offlineMode: boolean;
|
|
3
4
|
cloud: boolean;
|
|
4
|
-
accountPortalUrl
|
|
5
|
-
baseUrl: string;
|
|
5
|
+
accountPortalUrl?: string;
|
|
6
6
|
disableAccountPortal: boolean;
|
|
7
|
+
baseUrl?: string;
|
|
7
8
|
isDev: boolean;
|
|
9
|
+
maintenance: {
|
|
10
|
+
type: string;
|
|
11
|
+
}[];
|
|
12
|
+
passwordMinLength?: string;
|
|
8
13
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type GetLogResponse = Buffer;
|
package/dist/api/web/user.d.ts
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
|
-
import { User } from "../../documents";
|
|
1
|
+
import { AccountMetadata, PlatformUser, User } from "../../documents";
|
|
2
2
|
import { SearchFilters } from "../../sdk";
|
|
3
|
+
export interface Invite {
|
|
4
|
+
email: string;
|
|
5
|
+
info: any;
|
|
6
|
+
}
|
|
7
|
+
export interface InviteWithCode extends Invite {
|
|
8
|
+
code: string;
|
|
9
|
+
}
|
|
3
10
|
export interface SaveUserResponse {
|
|
4
11
|
_id: string;
|
|
5
12
|
_rev: string;
|
|
@@ -47,11 +54,24 @@ export interface InviteUserRequest {
|
|
|
47
54
|
email: string;
|
|
48
55
|
userInfo: any;
|
|
49
56
|
}
|
|
57
|
+
export interface InviteUserResponse {
|
|
58
|
+
message: string;
|
|
59
|
+
successful: {
|
|
60
|
+
email: string;
|
|
61
|
+
}[];
|
|
62
|
+
unsuccessful: {
|
|
63
|
+
email: string;
|
|
64
|
+
reason: string;
|
|
65
|
+
}[];
|
|
66
|
+
}
|
|
50
67
|
export interface DeleteInviteUserRequest {
|
|
51
68
|
code: string;
|
|
52
69
|
}
|
|
53
70
|
export type InviteUsersRequest = InviteUserRequest[];
|
|
54
71
|
export type DeleteInviteUsersRequest = DeleteInviteUserRequest[];
|
|
72
|
+
export interface DeleteInviteUsersResponse {
|
|
73
|
+
message: string;
|
|
74
|
+
}
|
|
55
75
|
export interface InviteUsersResponse {
|
|
56
76
|
successful: {
|
|
57
77
|
email: string;
|
|
@@ -69,6 +89,15 @@ export interface SearchUsersRequest {
|
|
|
69
89
|
limit?: number;
|
|
70
90
|
paginate?: boolean;
|
|
71
91
|
}
|
|
92
|
+
export interface SearchUsersResponse {
|
|
93
|
+
data: User[];
|
|
94
|
+
hasNextPage?: boolean;
|
|
95
|
+
nextPage?: string;
|
|
96
|
+
}
|
|
97
|
+
export type FetchUsersResponse = User[];
|
|
98
|
+
export interface FindUserResponse extends User {
|
|
99
|
+
}
|
|
100
|
+
export type LookupTenantUserResponse = PlatformUser;
|
|
72
101
|
export interface CreateAdminUserRequest {
|
|
73
102
|
email: string;
|
|
74
103
|
password?: string;
|
|
@@ -101,3 +130,23 @@ export interface AcceptUserInviteResponse {
|
|
|
101
130
|
export interface SyncUserRequest {
|
|
102
131
|
previousUser?: User;
|
|
103
132
|
}
|
|
133
|
+
export interface DeleteUserResponse {
|
|
134
|
+
message: string;
|
|
135
|
+
}
|
|
136
|
+
export interface CountUserResponse {
|
|
137
|
+
userCount: number;
|
|
138
|
+
}
|
|
139
|
+
export interface CheckInviteResponse {
|
|
140
|
+
email: string;
|
|
141
|
+
}
|
|
142
|
+
export type GetUserInvitesResponse = InviteWithCode[];
|
|
143
|
+
export interface UpdateInviteRequest extends Omit<Invite, "email"> {
|
|
144
|
+
email?: string;
|
|
145
|
+
builder?: {
|
|
146
|
+
apps: string[];
|
|
147
|
+
};
|
|
148
|
+
apps: string[];
|
|
149
|
+
}
|
|
150
|
+
export interface UpdateInviteResponse extends Invite {
|
|
151
|
+
}
|
|
152
|
+
export type LookupAccountHolderResponse = AccountMetadata | null;
|
package/dist/index.js
CHANGED
|
@@ -65,6 +65,7 @@ __export(src_exports, {
|
|
|
65
65
|
DeploymentStatus: () => DeploymentStatus,
|
|
66
66
|
DocumentType: () => DocumentType,
|
|
67
67
|
DocumentTypesToImport: () => DocumentTypesToImport,
|
|
68
|
+
EmailTemplatePurpose: () => EmailTemplatePurpose,
|
|
68
69
|
EmptyFilterOption: () => EmptyFilterOption,
|
|
69
70
|
Event: () => Event,
|
|
70
71
|
EventPublishType: () => EventPublishType,
|
|
@@ -286,6 +287,7 @@ var Event = /* @__PURE__ */ ((Event2) => {
|
|
|
286
287
|
Event2["VIEW_CALCULATION_CREATED"] = "view:calculation:created";
|
|
287
288
|
Event2["VIEW_CALCULATION_UPDATED"] = "view:calculation:updated";
|
|
288
289
|
Event2["VIEW_CALCULATION_DELETED"] = "view:calculation:deleted";
|
|
290
|
+
Event2["VIEW_JOIN_CREATED"] = "view:join:created";
|
|
289
291
|
Event2["ROWS_CREATED"] = "rows:created";
|
|
290
292
|
Event2["ROWS_IMPORTED"] = "rows:imported";
|
|
291
293
|
Event2["COMPONENT_CREATED"] = "component:created";
|
|
@@ -334,6 +336,7 @@ var Event = /* @__PURE__ */ ((Event2) => {
|
|
|
334
336
|
Event2["ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED"] = "environment_variable:upgrade_panel_opened";
|
|
335
337
|
Event2["AUDIT_LOGS_FILTERED"] = "audit_log:filtered";
|
|
336
338
|
Event2["AUDIT_LOGS_DOWNLOADED"] = "audit_log:downloaded";
|
|
339
|
+
Event2["ROW_ACTION_CREATED"] = "row_action:created";
|
|
337
340
|
return Event2;
|
|
338
341
|
})(Event || {});
|
|
339
342
|
var UserGroupSyncEvents = [
|
|
@@ -490,6 +493,7 @@ var AuditedEventFriendlyName = {
|
|
|
490
493
|
["view:calculation:created" /* VIEW_CALCULATION_CREATED */]: void 0,
|
|
491
494
|
["view:calculation:updated" /* VIEW_CALCULATION_UPDATED */]: void 0,
|
|
492
495
|
["view:calculation:deleted" /* VIEW_CALCULATION_DELETED */]: void 0,
|
|
496
|
+
["view:join:created" /* VIEW_JOIN_CREATED */]: void 0,
|
|
493
497
|
// SERVED - NOT AUDITED
|
|
494
498
|
["served:builder" /* SERVED_BUILDER */]: void 0,
|
|
495
499
|
["served:app" /* SERVED_APP */]: void 0,
|
|
@@ -504,7 +508,9 @@ var AuditedEventFriendlyName = {
|
|
|
504
508
|
["installation:firstStartup" /* INSTALLATION_FIRST_STARTUP */]: void 0,
|
|
505
509
|
// AUDIT LOG - NOT AUDITED
|
|
506
510
|
["audit_log:filtered" /* AUDIT_LOGS_FILTERED */]: void 0,
|
|
507
|
-
["audit_log:downloaded" /* AUDIT_LOGS_DOWNLOADED */]: void 0
|
|
511
|
+
["audit_log:downloaded" /* AUDIT_LOGS_DOWNLOADED */]: void 0,
|
|
512
|
+
// ROW ACTIONS - NOT AUDITED
|
|
513
|
+
["row_action:created" /* ROW_ACTION_CREATED */]: void 0
|
|
508
514
|
};
|
|
509
515
|
|
|
510
516
|
// src/sdk/events/identification.ts
|
|
@@ -1549,6 +1555,17 @@ var EventPublishType = /* @__PURE__ */ ((EventPublishType2) => {
|
|
|
1549
1555
|
return EventPublishType2;
|
|
1550
1556
|
})(EventPublishType || {});
|
|
1551
1557
|
|
|
1558
|
+
// src/api/web/global/email.ts
|
|
1559
|
+
var EmailTemplatePurpose = /* @__PURE__ */ ((EmailTemplatePurpose2) => {
|
|
1560
|
+
EmailTemplatePurpose2["CORE"] = "core";
|
|
1561
|
+
EmailTemplatePurpose2["BASE"] = "base";
|
|
1562
|
+
EmailTemplatePurpose2["PASSWORD_RECOVERY"] = "password_recovery";
|
|
1563
|
+
EmailTemplatePurpose2["INVITATION"] = "invitation";
|
|
1564
|
+
EmailTemplatePurpose2["WELCOME"] = "welcome";
|
|
1565
|
+
EmailTemplatePurpose2["CUSTOM"] = "custom";
|
|
1566
|
+
return EmailTemplatePurpose2;
|
|
1567
|
+
})(EmailTemplatePurpose || {});
|
|
1568
|
+
|
|
1552
1569
|
// src/api/web/template.ts
|
|
1553
1570
|
var TemplateType = /* @__PURE__ */ ((TemplateType2) => {
|
|
1554
1571
|
TemplateType2["APP"] = "app";
|
|
@@ -1623,6 +1640,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
|
|
|
1623
1640
|
DeploymentStatus,
|
|
1624
1641
|
DocumentType,
|
|
1625
1642
|
DocumentTypesToImport,
|
|
1643
|
+
EmailTemplatePurpose,
|
|
1626
1644
|
EmptyFilterOption,
|
|
1627
1645
|
Event,
|
|
1628
1646
|
EventPublishType,
|