@budibase/types 3.2.24 → 3.2.26

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.
Files changed (54) hide show
  1. package/dist/api/web/{application.d.ts → app/application.d.ts} +2 -2
  2. package/dist/api/web/app/automation.d.ts +49 -1
  3. package/dist/api/web/{deployment.d.ts → app/deployment.d.ts} +1 -1
  4. package/dist/api/web/app/index.d.ts +10 -1
  5. package/dist/api/web/app/integration.d.ts +3 -0
  6. package/dist/api/web/{layout.d.ts → app/layout.d.ts} +4 -1
  7. package/dist/api/web/app/metadata.d.ts +13 -0
  8. package/dist/api/web/app/permission.d.ts +3 -1
  9. package/dist/api/web/app/query.d.ts +44 -0
  10. package/dist/api/web/{role.d.ts → app/role.d.ts} +3 -3
  11. package/dist/api/web/app/rows/index.d.ts +23 -1
  12. package/dist/api/web/app/screen.d.ts +14 -0
  13. package/dist/api/web/app/static.d.ts +20 -0
  14. package/dist/api/web/app/table.d.ts +7 -4
  15. package/dist/api/web/app/user.d.ts +19 -2
  16. package/dist/api/web/app/view.d.ts +4 -0
  17. package/dist/api/web/app/webhook.d.ts +20 -0
  18. package/dist/api/web/auth.d.ts +13 -0
  19. package/dist/api/web/global/configs.d.ts +29 -1
  20. package/dist/api/web/global/email.d.ts +26 -0
  21. package/dist/api/web/global/index.d.ts +5 -0
  22. package/dist/api/web/global/license.d.ts +3 -0
  23. package/dist/api/web/global/oldMigration.d.ts +7 -0
  24. package/dist/api/web/global/role.d.ts +15 -0
  25. package/dist/api/web/global/self.d.ts +11 -0
  26. package/dist/api/web/global/template.d.ts +26 -0
  27. package/dist/api/web/index.d.ts +1 -6
  28. package/dist/api/web/plugins.d.ts +11 -1
  29. package/dist/api/web/system/account.d.ts +5 -0
  30. package/dist/api/web/system/environment.d.ts +7 -2
  31. package/dist/api/web/system/index.d.ts +6 -0
  32. package/dist/api/web/system/log.d.ts +1 -0
  33. package/dist/api/web/system/migration.d.ts +4 -0
  34. package/dist/api/web/system/ops.d.ts +7 -0
  35. package/dist/api/web/system/restore.d.ts +3 -0
  36. package/dist/api/web/system/tenant.d.ts +3 -0
  37. package/dist/api/web/template.d.ts +18 -0
  38. package/dist/api/web/user.d.ts +50 -1
  39. package/dist/documents/app/index.d.ts +1 -0
  40. package/dist/documents/app/metadata.d.ts +4 -0
  41. package/dist/documents/app/screen.d.ts +9 -0
  42. package/dist/documents/global/devInfo.d.ts +5 -0
  43. package/dist/documents/global/index.d.ts +1 -0
  44. package/dist/documents/global/plugin.d.ts +3 -3
  45. package/dist/index.js +30 -0
  46. package/dist/index.js.map +4 -4
  47. package/dist/index.js.meta.json +1 -1
  48. package/dist/sdk/auth.d.ts +2 -2
  49. package/dist/sdk/permissions.d.ts +16 -0
  50. package/dist/tsconfig.tsbuildinfo +1 -1
  51. package/package.json +3 -3
  52. package/dist/api/web/app/row.d.ts +0 -14
  53. package/dist/api/web/automation.d.ts +0 -49
  54. package/dist/api/web/query.d.ts +0 -23
@@ -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;
@@ -19,3 +19,4 @@ export * from "./snippet";
19
19
  export * from "./rowAction";
20
20
  export * from "./theme";
21
21
  export * from "./deployment";
22
+ export * from "./metadata";
@@ -0,0 +1,4 @@
1
+ export declare enum MetadataType {
2
+ AUTOMATION_TEST_INPUT = "automationTestInput",
3
+ AUTOMATION_TEST_HISTORY = "automationTestHistory"
4
+ }
@@ -21,3 +21,12 @@ export interface Screen extends Document {
21
21
  name?: string;
22
22
  pluginAdded?: boolean;
23
23
  }
24
+ export interface ScreenRoutesViewOutput extends Document {
25
+ id: string;
26
+ routing: ScreenRouting;
27
+ }
28
+ export type ScreenRoutingJson = Record<string, {
29
+ subpaths: Record<string, {
30
+ screens: Record<string, string>;
31
+ }>;
32
+ }>;
@@ -0,0 +1,5 @@
1
+ import { Document } from "../document";
2
+ export interface DevInfo extends Document {
3
+ userId: string;
4
+ apiKey?: string;
5
+ }
@@ -8,3 +8,4 @@ export * from "./templates";
8
8
  export * from "./environmentVariables";
9
9
  export * from "./auditLogs";
10
10
  export * from "./apikeys";
11
+ export * from "./devInfo";
@@ -10,9 +10,9 @@ export declare enum PluginSource {
10
10
  URL = "URL",
11
11
  FILE = "File Upload"
12
12
  }
13
- export interface FileType {
14
- path: string;
15
- name: string;
13
+ export interface KoaFile {
14
+ path: string | null;
15
+ name: string | null;
16
16
  }
17
17
  export interface Plugin extends Document {
18
18
  description: string;
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,
@@ -92,6 +93,7 @@ __export(src_exports, {
92
93
  LoginMethod: () => LoginMethod,
93
94
  LoopStepType: () => LoopStepType,
94
95
  MaintenanceType: () => MaintenanceType,
96
+ MetadataType: () => MetadataType,
95
97
  MigrationName: () => MigrationName,
96
98
  MigrationType: () => MigrationType,
97
99
  Model: () => Model,
@@ -132,6 +134,7 @@ __export(src_exports, {
132
134
  SqlClient: () => SqlClient,
133
135
  StaticQuotaName: () => StaticQuotaName,
134
136
  TableSourceType: () => TableSourceType,
137
+ TemplateType: () => TemplateType,
135
138
  TenantResolutionStrategy: () => TenantResolutionStrategy,
136
139
  Theme: () => Theme,
137
140
  UILogicalOperator: () => UILogicalOperator,
@@ -1366,6 +1369,13 @@ var DeploymentStatus = /* @__PURE__ */ ((DeploymentStatus2) => {
1366
1369
  return DeploymentStatus2;
1367
1370
  })(DeploymentStatus || {});
1368
1371
 
1372
+ // src/documents/app/metadata.ts
1373
+ var MetadataType = /* @__PURE__ */ ((MetadataType2) => {
1374
+ MetadataType2["AUTOMATION_TEST_INPUT"] = "automationTestInput";
1375
+ MetadataType2["AUTOMATION_TEST_HISTORY"] = "automationTestHistory";
1376
+ return MetadataType2;
1377
+ })(MetadataType || {});
1378
+
1369
1379
  // src/documents/global/config.ts
1370
1380
  var isSettingsConfig = (config) => config.type === "settings" /* SETTINGS */;
1371
1381
  var isSMTPConfig = (config) => config.type === "smtp" /* SMTP */;
@@ -1540,6 +1550,23 @@ var EventPublishType = /* @__PURE__ */ ((EventPublishType2) => {
1540
1550
  return EventPublishType2;
1541
1551
  })(EventPublishType || {});
1542
1552
 
1553
+ // src/api/web/global/email.ts
1554
+ var EmailTemplatePurpose = /* @__PURE__ */ ((EmailTemplatePurpose2) => {
1555
+ EmailTemplatePurpose2["CORE"] = "core";
1556
+ EmailTemplatePurpose2["BASE"] = "base";
1557
+ EmailTemplatePurpose2["PASSWORD_RECOVERY"] = "password_recovery";
1558
+ EmailTemplatePurpose2["INVITATION"] = "invitation";
1559
+ EmailTemplatePurpose2["WELCOME"] = "welcome";
1560
+ EmailTemplatePurpose2["CUSTOM"] = "custom";
1561
+ return EmailTemplatePurpose2;
1562
+ })(EmailTemplatePurpose || {});
1563
+
1564
+ // src/api/web/template.ts
1565
+ var TemplateType = /* @__PURE__ */ ((TemplateType2) => {
1566
+ TemplateType2["APP"] = "app";
1567
+ return TemplateType2;
1568
+ })(TemplateType || {});
1569
+
1543
1570
  // src/core/installation.ts
1544
1571
  var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
1545
1572
  ServiceType2["WORKER"] = "worker";
@@ -1608,6 +1635,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
1608
1635
  DeploymentStatus,
1609
1636
  DocumentType,
1610
1637
  DocumentTypesToImport,
1638
+ EmailTemplatePurpose,
1611
1639
  EmptyFilterOption,
1612
1640
  Event,
1613
1641
  EventPublishType,
@@ -1635,6 +1663,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
1635
1663
  LoginMethod,
1636
1664
  LoopStepType,
1637
1665
  MaintenanceType,
1666
+ MetadataType,
1638
1667
  MigrationName,
1639
1668
  MigrationType,
1640
1669
  Model,
@@ -1675,6 +1704,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
1675
1704
  SqlClient,
1676
1705
  StaticQuotaName,
1677
1706
  TableSourceType,
1707
+ TemplateType,
1678
1708
  TenantResolutionStrategy,
1679
1709
  Theme,
1680
1710
  UILogicalOperator,