@budibase/types 2.3.18-alpha.3 → 2.3.18-alpha.30

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 (95) hide show
  1. package/dist/api/web/global/auditLogs.d.ts +39 -0
  2. package/dist/api/web/global/auditLogs.js +8 -0
  3. package/dist/api/web/global/auditLogs.js.map +1 -0
  4. package/dist/api/web/global/configs.d.ts +19 -0
  5. package/dist/api/web/global/configs.js +3 -0
  6. package/dist/api/web/global/configs.js.map +1 -0
  7. package/dist/api/web/global/index.d.ts +2 -0
  8. package/dist/api/web/global/index.js +2 -0
  9. package/dist/api/web/global/index.js.map +1 -1
  10. package/dist/api/web/index.d.ts +1 -0
  11. package/dist/api/web/index.js +1 -0
  12. package/dist/api/web/index.js.map +1 -1
  13. package/dist/api/web/pagination.d.ts +23 -0
  14. package/dist/api/web/pagination.js +14 -0
  15. package/dist/api/web/pagination.js.map +1 -0
  16. package/dist/api/web/user.d.ts +2 -1
  17. package/dist/documents/global/auditLogs.d.ts +16 -0
  18. package/dist/documents/global/auditLogs.js +5 -0
  19. package/dist/documents/global/auditLogs.js.map +1 -0
  20. package/dist/documents/global/config.d.ts +34 -18
  21. package/dist/documents/global/config.js.map +1 -1
  22. package/dist/documents/global/index.d.ts +1 -0
  23. package/dist/documents/global/index.js +1 -0
  24. package/dist/documents/global/index.js.map +1 -1
  25. package/dist/documents/global/user.d.ts +5 -1
  26. package/dist/documents/global/user.js +6 -1
  27. package/dist/documents/global/user.js.map +1 -1
  28. package/dist/sdk/auditLogs.d.ts +15 -0
  29. package/dist/sdk/auditLogs.js +3 -0
  30. package/dist/sdk/auditLogs.js.map +1 -0
  31. package/dist/sdk/cli/constants.d.ts +18 -0
  32. package/dist/sdk/cli/constants.js +24 -0
  33. package/dist/sdk/cli/constants.js.map +1 -0
  34. package/dist/sdk/cli/index.d.ts +1 -0
  35. package/dist/sdk/cli/index.js +18 -0
  36. package/dist/sdk/cli/index.js.map +1 -0
  37. package/dist/sdk/context.d.ts +2 -1
  38. package/dist/sdk/db.d.ts +18 -1
  39. package/dist/sdk/db.js +6 -1
  40. package/dist/sdk/db.js.map +1 -1
  41. package/dist/sdk/events/app.d.ts +33 -0
  42. package/dist/sdk/events/auditLog.d.ts +8 -0
  43. package/dist/sdk/events/auditLog.js +3 -0
  44. package/dist/sdk/events/auditLog.js.map +1 -0
  45. package/dist/sdk/events/auth.d.ts +6 -0
  46. package/dist/sdk/events/automation.d.ts +12 -0
  47. package/dist/sdk/events/backup.d.ts +2 -0
  48. package/dist/sdk/events/event.d.ts +7 -1
  49. package/dist/sdk/events/event.js +160 -1
  50. package/dist/sdk/events/event.js.map +1 -1
  51. package/dist/sdk/events/identification.d.ts +5 -0
  52. package/dist/sdk/events/index.d.ts +1 -0
  53. package/dist/sdk/events/index.js +1 -0
  54. package/dist/sdk/events/index.js.map +1 -1
  55. package/dist/sdk/events/screen.d.ts +6 -0
  56. package/dist/sdk/events/table.d.ts +15 -0
  57. package/dist/sdk/events/user.d.ts +36 -0
  58. package/dist/sdk/events/userGroup.d.ts +22 -0
  59. package/dist/sdk/index.d.ts +2 -0
  60. package/dist/sdk/index.js +2 -0
  61. package/dist/sdk/index.js.map +1 -1
  62. package/dist/sdk/licensing/feature.d.ts +3 -1
  63. package/dist/sdk/licensing/feature.js +2 -0
  64. package/dist/sdk/licensing/feature.js.map +1 -1
  65. package/dist/tsconfig.build.tsbuildinfo +1 -1
  66. package/package.json +2 -2
  67. package/src/api/web/global/auditLogs.ts +51 -0
  68. package/src/api/web/global/configs.ts +23 -0
  69. package/src/api/web/global/index.ts +2 -0
  70. package/src/api/web/index.ts +1 -0
  71. package/src/api/web/pagination.ts +27 -0
  72. package/src/api/web/user.ts +2 -1
  73. package/src/documents/global/auditLogs.ts +19 -0
  74. package/src/documents/global/config.ts +38 -19
  75. package/src/documents/global/index.ts +1 -0
  76. package/src/documents/global/user.ts +6 -1
  77. package/src/sdk/auditLogs.ts +22 -0
  78. package/src/sdk/cli/constants.ts +21 -0
  79. package/src/sdk/cli/index.ts +1 -0
  80. package/src/sdk/context.ts +2 -1
  81. package/src/sdk/db.ts +19 -1
  82. package/src/sdk/events/app.ts +33 -0
  83. package/src/sdk/events/auditLog.ts +10 -0
  84. package/src/sdk/events/auth.ts +6 -0
  85. package/src/sdk/events/automation.ts +12 -0
  86. package/src/sdk/events/backup.ts +2 -0
  87. package/src/sdk/events/event.ts +189 -0
  88. package/src/sdk/events/identification.ts +6 -0
  89. package/src/sdk/events/index.ts +1 -0
  90. package/src/sdk/events/screen.ts +6 -0
  91. package/src/sdk/events/table.ts +15 -0
  92. package/src/sdk/events/user.ts +38 -1
  93. package/src/sdk/events/userGroup.ts +23 -0
  94. package/src/sdk/index.ts +2 -0
  95. package/src/sdk/licensing/feature.ts +2 -0
@@ -0,0 +1,39 @@
1
+ import { Event } from "../../../sdk";
2
+ import { PaginationResponse, BasicPaginationRequest } from "../";
3
+ import { User, App } from "../../../";
4
+ export interface AuditLogSearchParams {
5
+ userIds?: string[];
6
+ appIds?: string[];
7
+ events?: Event[];
8
+ startDate?: string;
9
+ endDate?: string;
10
+ fullSearch?: string;
11
+ bookmark?: string;
12
+ }
13
+ export interface DownloadAuditLogsRequest extends AuditLogSearchParams {
14
+ }
15
+ export interface SearchAuditLogsRequest extends BasicPaginationRequest, AuditLogSearchParams {
16
+ }
17
+ export declare enum AuditLogResourceStatus {
18
+ DELETED = "deleted"
19
+ }
20
+ export declare type DeletedResourceInfo = {
21
+ _id: string;
22
+ status: AuditLogResourceStatus;
23
+ email?: string;
24
+ name?: string;
25
+ };
26
+ export interface AuditLogEnriched {
27
+ app?: App | DeletedResourceInfo;
28
+ user: User | DeletedResourceInfo;
29
+ event: Event;
30
+ timestamp: string;
31
+ name: string;
32
+ metadata: any;
33
+ }
34
+ export interface SearchAuditLogsResponse extends PaginationResponse {
35
+ data: AuditLogEnriched[];
36
+ }
37
+ export interface DefinitionsAuditLogsResponse {
38
+ events: Record<string, string>;
39
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AuditLogResourceStatus = void 0;
4
+ var AuditLogResourceStatus;
5
+ (function (AuditLogResourceStatus) {
6
+ AuditLogResourceStatus["DELETED"] = "deleted";
7
+ })(AuditLogResourceStatus = exports.AuditLogResourceStatus || (exports.AuditLogResourceStatus = {}));
8
+ //# sourceMappingURL=auditLogs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auditLogs.js","sourceRoot":"","sources":["../../../../src/api/web/global/auditLogs.ts"],"names":[],"mappings":";;;AAwBA,IAAY,sBAEX;AAFD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;AACrB,CAAC,EAFW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAEjC"}
@@ -0,0 +1,19 @@
1
+ import { SettingsConfig, SettingsInnerConfig } from "../../../documents";
2
+ /**
3
+ * Settings that aren't stored in the database - enriched at runtime.
4
+ */
5
+ export interface PublicSettingsInnerConfig extends SettingsInnerConfig {
6
+ google: boolean;
7
+ oidc: boolean;
8
+ oidcCallbackUrl: string;
9
+ googleCallbackUrl: string;
10
+ }
11
+ export interface GetPublicSettingsResponse extends SettingsConfig {
12
+ config: PublicSettingsInnerConfig;
13
+ }
14
+ export interface PublicOIDCConfig {
15
+ logo?: string;
16
+ name?: string;
17
+ uuid?: string;
18
+ }
19
+ export declare type GetPublicOIDCConfigResponse = PublicOIDCConfig[];
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=configs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"configs.js","sourceRoot":"","sources":["../../../../src/api/web/global/configs.ts"],"names":[],"mappings":""}
@@ -1,2 +1,4 @@
1
1
  export * from "./environmentVariables";
2
+ export * from "./auditLogs";
2
3
  export * from "./events";
4
+ export * from "./configs";
@@ -15,5 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./environmentVariables"), exports);
18
+ __exportStar(require("./auditLogs"), exports);
18
19
  __exportStar(require("./events"), exports);
20
+ __exportStar(require("./configs"), exports);
19
21
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,2CAAwB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,8CAA2B;AAC3B,2CAAwB;AACxB,4CAAyB"}
@@ -5,3 +5,4 @@ export * from "./errors";
5
5
  export * from "./schedule";
6
6
  export * from "./app";
7
7
  export * from "./global";
8
+ export * from "./pagination";
@@ -21,4 +21,5 @@ __exportStar(require("./errors"), exports);
21
21
  __exportStar(require("./schedule"), exports);
22
22
  __exportStar(require("./app"), exports);
23
23
  __exportStar(require("./global"), exports);
24
+ __exportStar(require("./pagination"), exports);
24
25
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,wCAAqB;AACrB,2CAAwB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}
@@ -0,0 +1,23 @@
1
+ export declare enum SortOrder {
2
+ ASCENDING = "ascending",
3
+ DESCENDING = "descending"
4
+ }
5
+ export declare enum SortType {
6
+ STRING = "string",
7
+ number = "number"
8
+ }
9
+ export interface BasicPaginationRequest {
10
+ bookmark?: string;
11
+ }
12
+ export interface PaginationRequest extends BasicPaginationRequest {
13
+ limit?: number;
14
+ sort?: {
15
+ order: SortOrder;
16
+ column: string;
17
+ type: SortType;
18
+ };
19
+ }
20
+ export interface PaginationResponse {
21
+ bookmark: string;
22
+ hasNextPage: boolean;
23
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SortType = exports.SortOrder = void 0;
4
+ var SortOrder;
5
+ (function (SortOrder) {
6
+ SortOrder["ASCENDING"] = "ascending";
7
+ SortOrder["DESCENDING"] = "descending";
8
+ })(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
9
+ var SortType;
10
+ (function (SortType) {
11
+ SortType["STRING"] = "string";
12
+ SortType["number"] = "number";
13
+ })(SortType = exports.SortType || (exports.SortType = {}));
14
+ //# sourceMappingURL=pagination.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../src/api/web/pagination.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;AAC3B,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;AACnB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}
@@ -13,6 +13,7 @@ export interface BulkUserRequest {
13
13
  userIds: string[];
14
14
  };
15
15
  create?: {
16
+ roles?: any[];
16
17
  users: User[];
17
18
  groups: any[];
18
19
  };
@@ -53,7 +54,7 @@ export interface SearchUsersRequest {
53
54
  page?: string;
54
55
  email?: string;
55
56
  appId?: string;
56
- userIds?: string[];
57
+ paginated?: boolean;
57
58
  }
58
59
  export interface CreateAdminUserRequest {
59
60
  email: string;
@@ -0,0 +1,16 @@
1
+ import { Document } from "../document";
2
+ import { Event } from "../../sdk";
3
+ export declare const AuditLogSystemUser = "SYSTEM";
4
+ export declare type FallbackInfo = {
5
+ appName?: string;
6
+ email?: string;
7
+ };
8
+ export interface AuditLogDoc extends Document {
9
+ appId?: string;
10
+ event: Event;
11
+ userId: string;
12
+ timestamp: string;
13
+ metadata: any;
14
+ name: string;
15
+ fallback?: FallbackInfo;
16
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AuditLogSystemUser = void 0;
4
+ exports.AuditLogSystemUser = "SYSTEM";
5
+ //# sourceMappingURL=auditLogs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auditLogs.js","sourceRoot":"","sources":["../../../src/documents/global/auditLogs.ts"],"names":[],"mappings":";;;AAGa,QAAA,kBAAkB,GAAG,QAAQ,CAAA"}
@@ -3,29 +3,43 @@ export interface Config extends Document {
3
3
  type: ConfigType;
4
4
  config: any;
5
5
  }
6
- export interface SMTPConfig extends Config {
7
- config: {
8
- port: number;
9
- host: string;
10
- from: string;
11
- subject: string;
12
- secure: boolean;
6
+ export interface SMTPInnerConfig {
7
+ port: number;
8
+ host: string;
9
+ from: string;
10
+ subject?: string;
11
+ secure: boolean;
12
+ auth?: {
13
+ user: string;
14
+ pass: string;
13
15
  };
16
+ connectionTimeout?: any;
17
+ }
18
+ export interface SMTPConfig extends Config {
19
+ config: SMTPInnerConfig;
20
+ }
21
+ export interface SettingsInnerConfig {
22
+ platformUrl?: string;
23
+ company?: string;
24
+ logoUrl?: string;
25
+ logoUrlEtag?: string;
26
+ uniqueTenantId?: string;
27
+ analyticsEnabled?: boolean;
28
+ isSSOEnforced?: boolean;
14
29
  }
15
30
  export interface SettingsConfig extends Config {
16
- config: {
17
- company: string;
18
- logoUrl?: string;
19
- logoUrlEtag?: boolean;
20
- platformUrl: string;
21
- uniqueTenantId?: string;
22
- analyticsEnabled?: boolean;
23
- };
31
+ config: SettingsInnerConfig;
24
32
  }
33
+ export declare type SSOConfigType = ConfigType.GOOGLE | ConfigType.OIDC;
34
+ export declare type SSOConfig = GoogleInnerConfig | OIDCInnerConfig;
25
35
  export interface GoogleInnerConfig {
26
36
  clientID: string;
27
37
  clientSecret: string;
28
38
  activated: boolean;
39
+ /**
40
+ * @deprecated read only
41
+ */
42
+ callbackURL?: string;
29
43
  }
30
44
  export interface GoogleConfig extends Config {
31
45
  config: GoogleInnerConfig;
@@ -39,6 +53,9 @@ export interface OIDCStrategyConfiguration {
39
53
  clientSecret: string;
40
54
  callbackURL: string;
41
55
  }
56
+ export interface OIDCConfigs {
57
+ configs: OIDCInnerConfig[];
58
+ }
42
59
  export interface OIDCInnerConfig {
43
60
  configUrl: string;
44
61
  clientID: string;
@@ -47,11 +64,10 @@ export interface OIDCInnerConfig {
47
64
  name: string;
48
65
  uuid: string;
49
66
  activated: boolean;
67
+ scopes: string[];
50
68
  }
51
69
  export interface OIDCConfig extends Config {
52
- config: {
53
- configs: OIDCInnerConfig[];
54
- };
70
+ config: OIDCConfigs;
55
71
  }
56
72
  export interface OIDCWellKnownConfig {
57
73
  issuer: string;
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/documents/global/config.ts"],"names":[],"mappings":";;;AAwEO,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE,CAC3E,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAA;AADxB,QAAA,gBAAgB,oBACQ;AAE9B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAE1B,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE,CACvE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAEjC,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,uCAAyB,CAAA;AAC3B,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/documents/global/config.ts"],"names":[],"mappings":";;;AA2FO,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE,CAC3E,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAA;AADxB,QAAA,gBAAgB,oBACQ;AAE9B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAE1B,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE,CACvE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAEjC,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,uCAAyB,CAAA;AAC3B,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB"}
@@ -6,3 +6,4 @@ export * from "./quotas";
6
6
  export * from "./schedule";
7
7
  export * from "./templates";
8
8
  export * from "./environmentVariables";
9
+ export * from "./auditLogs";
@@ -22,4 +22,5 @@ __exportStar(require("./quotas"), exports);
22
22
  __exportStar(require("./schedule"), exports);
23
23
  __exportStar(require("./templates"), exports);
24
24
  __exportStar(require("./environmentVariables"), exports);
25
+ __exportStar(require("./auditLogs"), exports);
25
26
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,2CAAwB;AACxB,2CAAwB;AACxB,6CAA0B;AAC1B,8CAA2B;AAC3B,yDAAsC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,2CAAwB;AACxB,2CAAwB;AACxB,6CAA0B;AAC1B,8CAA2B;AAC3B,yDAAsC;AACtC,8CAA2B"}
@@ -35,12 +35,16 @@ export interface User extends Document {
35
35
  global: boolean;
36
36
  };
37
37
  password?: string;
38
- status?: string;
38
+ status?: UserStatus;
39
39
  createdAt?: number;
40
40
  dayPassRecordedAt?: string;
41
41
  userGroups?: string[];
42
42
  onboardedAt?: string;
43
43
  }
44
+ export declare enum UserStatus {
45
+ ACTIVE = "active",
46
+ INACTIVE = "inactive"
47
+ }
44
48
  export interface UserRoles {
45
49
  [key: string]: string;
46
50
  }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isUser = exports.isSSOUser = exports.SSOProviderType = void 0;
3
+ exports.isUser = exports.UserStatus = exports.isSSOUser = exports.SSOProviderType = void 0;
4
4
  var SSOProviderType;
5
5
  (function (SSOProviderType) {
6
6
  SSOProviderType["OIDC"] = "oidc";
@@ -10,6 +10,11 @@ function isSSOUser(user) {
10
10
  return !!user.providerType;
11
11
  }
12
12
  exports.isSSOUser = isSSOUser;
13
+ var UserStatus;
14
+ (function (UserStatus) {
15
+ UserStatus["ACTIVE"] = "active";
16
+ UserStatus["INACTIVE"] = "inactive";
17
+ })(UserStatus = exports.UserStatus || (exports.UserStatus = {}));
13
18
  function isUser(user) {
14
19
  return !!user.roles;
15
20
  }
@@ -1 +1 @@
1
- {"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/documents/global/user.ts"],"names":[],"mappings":";;;AAcA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAWD,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,CAAC,CAAE,IAAgB,CAAC,YAAY,CAAA;AACzC,CAAC;AAFD,8BAEC;AAgDD,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,CAAE,IAAa,CAAC,KAAK,CAAA;AAC/B,CAAC;AAFD,wBAEC"}
1
+ {"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/documents/global/user.ts"],"names":[],"mappings":";;;AAcA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAWD,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,CAAC,CAAE,IAAgB,CAAC,YAAY,CAAA;AACzC,CAAC;AAFD,8BAEC;AA2BD,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;AACvB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAuBD,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,CAAE,IAAa,CAAC,KAAK,CAAA;AAC/B,CAAC;AAFD,wBAEC"}
@@ -0,0 +1,15 @@
1
+ import { Event, HostInfo } from "./events";
2
+ import { AuditLogDoc } from "../documents";
3
+ export declare type AuditWriteOpts = {
4
+ appId?: string;
5
+ timestamp?: string | number;
6
+ userId?: string;
7
+ hostInfo?: HostInfo;
8
+ };
9
+ export declare type AuditLogFn = (event: Event, metadata: any, opts: AuditWriteOpts) => Promise<AuditLogDoc | undefined>;
10
+ export declare type AuditLogQueueEvent = {
11
+ event: Event;
12
+ properties: any;
13
+ opts: AuditWriteOpts;
14
+ tenantId: string;
15
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=auditLogs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auditLogs.js","sourceRoot":"","sources":["../../src/sdk/auditLogs.ts"],"names":[],"mappings":""}
@@ -0,0 +1,18 @@
1
+ import { Event } from "../events";
2
+ export declare enum CommandWord {
3
+ BACKUPS = "backups",
4
+ HOSTING = "hosting",
5
+ ANALYTICS = "analytics",
6
+ HELP = "help",
7
+ PLUGIN = "plugins"
8
+ }
9
+ export declare enum InitType {
10
+ QUICK = "quick",
11
+ DIGITAL_OCEAN = "do"
12
+ }
13
+ export declare const AnalyticsEvent: {
14
+ OptOut: string;
15
+ OptIn: string;
16
+ SelfHostInit: string;
17
+ PluginInit: Event;
18
+ };
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AnalyticsEvent = exports.InitType = exports.CommandWord = void 0;
4
+ const events_1 = require("../events");
5
+ var CommandWord;
6
+ (function (CommandWord) {
7
+ CommandWord["BACKUPS"] = "backups";
8
+ CommandWord["HOSTING"] = "hosting";
9
+ CommandWord["ANALYTICS"] = "analytics";
10
+ CommandWord["HELP"] = "help";
11
+ CommandWord["PLUGIN"] = "plugins";
12
+ })(CommandWord = exports.CommandWord || (exports.CommandWord = {}));
13
+ var InitType;
14
+ (function (InitType) {
15
+ InitType["QUICK"] = "quick";
16
+ InitType["DIGITAL_OCEAN"] = "do";
17
+ })(InitType = exports.InitType || (exports.InitType = {}));
18
+ exports.AnalyticsEvent = {
19
+ OptOut: "analytics:opt:out",
20
+ OptIn: "analytics:opt:in",
21
+ SelfHostInit: "hosting:init",
22
+ PluginInit: events_1.Event.PLUGIN_INIT,
23
+ };
24
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/sdk/cli/constants.ts"],"names":[],"mappings":";;;AAAA,sCAAiC;AAEjC,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,4BAAa,CAAA;IACb,iCAAkB,CAAA;AACpB,CAAC,EANW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAMtB;AAED,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,gCAAoB,CAAA;AACtB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB;AAEY,QAAA,cAAc,GAAG;IAC5B,MAAM,EAAE,mBAAmB;IAC3B,KAAK,EAAE,kBAAkB;IACzB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,cAAK,CAAC,WAAW;CAC9B,CAAA"}
@@ -0,0 +1 @@
1
+ export * from "./constants";
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./constants"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/cli/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B"}
@@ -1,5 +1,5 @@
1
1
  import { User, Account } from "../documents";
2
- import { IdentityType } from "./events";
2
+ import { IdentityType, HostInfo } from "./events";
3
3
  export interface BaseContext {
4
4
  _id: string;
5
5
  type: IdentityType;
@@ -13,5 +13,6 @@ export interface UserContext extends BaseContext, User {
13
13
  _id: string;
14
14
  tenantId: string;
15
15
  account?: Account;
16
+ hostInfo: HostInfo;
16
17
  }
17
18
  export declare type IdentityContext = BaseContext | AccountUserContext | UserContext;
package/dist/sdk/db.d.ts CHANGED
@@ -1,6 +1,12 @@
1
1
  /// <reference types="pouchdb-find" />
2
+ /// <reference types="node" />
2
3
  import Nano from "@budibase/nano";
3
4
  import { AllDocsResponse, AnyDocument, Document } from "../";
5
+ import { Writable } from "stream";
6
+ export declare enum SearchIndex {
7
+ ROWS = "rows",
8
+ AUDIT = "audit"
9
+ }
4
10
  export declare type PouchOptions = {
5
11
  inMemory?: boolean;
6
12
  replication?: boolean;
@@ -52,6 +58,17 @@ export declare type DatabaseQueryOpts = {
52
58
  group?: boolean;
53
59
  };
54
60
  export declare const isDocument: (doc: any) => doc is Document;
61
+ export interface DatabaseDumpOpts {
62
+ filter?: (doc: AnyDocument) => boolean;
63
+ batch_size?: number;
64
+ batch_limit?: number;
65
+ style?: "main_only" | "all_docs";
66
+ timeout?: number;
67
+ doc_ids?: string[];
68
+ query_params?: any;
69
+ view?: string;
70
+ selector?: any;
71
+ }
55
72
  export interface Database {
56
73
  name: string;
57
74
  exists(): Promise<boolean>;
@@ -64,7 +81,7 @@ export interface Database {
64
81
  query<T>(viewName: string, params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>;
65
82
  destroy(): Promise<Nano.OkResponse | void>;
66
83
  compact(): Promise<Nano.OkResponse | void>;
67
- dump(...args: any[]): Promise<any>;
84
+ dump(stream: Writable, opts?: DatabaseDumpOpts): Promise<any>;
68
85
  load(...args: any[]): Promise<any>;
69
86
  createIndex(...args: any[]): Promise<any>;
70
87
  deleteIndex(...args: any[]): Promise<any>;
package/dist/sdk/db.js CHANGED
@@ -1,6 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isDocument = exports.SortOption = void 0;
3
+ exports.isDocument = exports.SortOption = exports.SearchIndex = void 0;
4
+ var SearchIndex;
5
+ (function (SearchIndex) {
6
+ SearchIndex["ROWS"] = "rows";
7
+ SearchIndex["AUDIT"] = "audit";
8
+ })(SearchIndex = exports.SearchIndex || (exports.SearchIndex = {}));
4
9
  var SortOption;
5
10
  (function (SortOption) {
6
11
  SortOption["ASCENDING"] = "asc";
@@ -1 +1 @@
1
- {"version":3,"file":"db.js","sourceRoot":"","sources":["../../src/sdk/db.ts"],"names":[],"mappings":";;;AAUA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAgDM,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAmB,EAAE;IACtD,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAA;AACvD,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB"}
1
+ {"version":3,"file":"db.js","sourceRoot":"","sources":["../../src/sdk/db.ts"],"names":[],"mappings":";;;AAIA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AASD,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAgDM,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAmB,EAAE;IACtD,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAA;AACvD,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB"}
@@ -2,40 +2,73 @@ import { BaseEvent } from "./event";
2
2
  export interface AppCreatedEvent extends BaseEvent {
3
3
  appId: string;
4
4
  version: string;
5
+ audited: {
6
+ name: string;
7
+ };
5
8
  }
6
9
  export interface AppUpdatedEvent extends BaseEvent {
7
10
  appId: string;
8
11
  version: string;
12
+ audited: {
13
+ name: string;
14
+ };
9
15
  }
10
16
  export interface AppDeletedEvent extends BaseEvent {
11
17
  appId: string;
18
+ audited: {
19
+ name: string;
20
+ };
12
21
  }
13
22
  export interface AppPublishedEvent extends BaseEvent {
14
23
  appId: string;
24
+ audited: {
25
+ name: string;
26
+ };
15
27
  }
16
28
  export interface AppUnpublishedEvent extends BaseEvent {
17
29
  appId: string;
30
+ audited: {
31
+ name: string;
32
+ };
18
33
  }
19
34
  export interface AppFileImportedEvent extends BaseEvent {
20
35
  appId: string;
36
+ audited: {
37
+ name: string;
38
+ };
21
39
  }
22
40
  export interface AppTemplateImportedEvent extends BaseEvent {
23
41
  appId: string;
24
42
  templateKey: string;
43
+ audited: {
44
+ name: string;
45
+ };
25
46
  }
26
47
  export interface AppVersionUpdatedEvent extends BaseEvent {
27
48
  appId: string;
28
49
  currentVersion: string;
29
50
  updatedToVersion: string;
51
+ audited: {
52
+ name: string;
53
+ };
30
54
  }
31
55
  export interface AppVersionRevertedEvent extends BaseEvent {
32
56
  appId: string;
33
57
  currentVersion: string;
34
58
  revertedToVersion: string;
59
+ audited: {
60
+ name: string;
61
+ };
35
62
  }
36
63
  export interface AppRevertedEvent extends BaseEvent {
37
64
  appId: string;
65
+ audited: {
66
+ name: string;
67
+ };
38
68
  }
39
69
  export interface AppExportedEvent extends BaseEvent {
40
70
  appId: string;
71
+ audited: {
72
+ name: string;
73
+ };
41
74
  }
@@ -0,0 +1,8 @@
1
+ import { BaseEvent } from "./event";
2
+ import { AuditLogSearchParams } from "../../api";
3
+ export interface AuditLogFilteredEvent extends BaseEvent {
4
+ filters: AuditLogSearchParams;
5
+ }
6
+ export interface AuditLogDownloadedEvent extends BaseEvent {
7
+ filters: AuditLogSearchParams;
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=auditLog.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auditLog.js","sourceRoot":"","sources":["../../../src/sdk/events/auditLog.ts"],"names":[],"mappings":""}
@@ -5,9 +5,15 @@ export declare type SSOType = ConfigType.OIDC | ConfigType.GOOGLE;
5
5
  export interface LoginEvent extends BaseEvent {
6
6
  userId: string;
7
7
  source: LoginSource;
8
+ audited: {
9
+ email: string;
10
+ };
8
11
  }
9
12
  export interface LogoutEvent extends BaseEvent {
10
13
  userId: string;
14
+ audited: {
15
+ email?: string;
16
+ };
11
17
  }
12
18
  export interface SSOCreatedEvent extends BaseEvent {
13
19
  type: SSOType;