@budibase/types 2.3.18-alpha.13 → 2.3.18-alpha.15

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 (74) 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/index.d.ts +1 -0
  5. package/dist/api/web/global/index.js +1 -0
  6. package/dist/api/web/global/index.js.map +1 -1
  7. package/dist/api/web/index.d.ts +1 -0
  8. package/dist/api/web/index.js +1 -0
  9. package/dist/api/web/index.js.map +1 -1
  10. package/dist/api/web/pagination.d.ts +23 -0
  11. package/dist/api/web/pagination.js +14 -0
  12. package/dist/api/web/pagination.js.map +1 -0
  13. package/dist/documents/global/auditLogs.d.ts +11 -0
  14. package/dist/documents/global/auditLogs.js +5 -0
  15. package/dist/documents/global/auditLogs.js.map +1 -0
  16. package/dist/documents/global/index.d.ts +1 -0
  17. package/dist/documents/global/index.js +1 -0
  18. package/dist/documents/global/index.js.map +1 -1
  19. package/dist/sdk/auditLogs.d.ts +14 -0
  20. package/dist/sdk/auditLogs.js +3 -0
  21. package/dist/sdk/auditLogs.js.map +1 -0
  22. package/dist/sdk/context.d.ts +2 -1
  23. package/dist/sdk/db.d.ts +18 -1
  24. package/dist/sdk/db.js +6 -1
  25. package/dist/sdk/db.js.map +1 -1
  26. package/dist/sdk/events/app.d.ts +33 -0
  27. package/dist/sdk/events/auditLog.d.ts +8 -0
  28. package/dist/sdk/events/auditLog.js +3 -0
  29. package/dist/sdk/events/auditLog.js.map +1 -0
  30. package/dist/sdk/events/auth.d.ts +6 -0
  31. package/dist/sdk/events/automation.d.ts +12 -0
  32. package/dist/sdk/events/backup.d.ts +2 -0
  33. package/dist/sdk/events/event.d.ts +7 -1
  34. package/dist/sdk/events/event.js +160 -1
  35. package/dist/sdk/events/event.js.map +1 -1
  36. package/dist/sdk/events/identification.d.ts +5 -0
  37. package/dist/sdk/events/index.d.ts +1 -0
  38. package/dist/sdk/events/index.js +1 -0
  39. package/dist/sdk/events/index.js.map +1 -1
  40. package/dist/sdk/events/screen.d.ts +6 -0
  41. package/dist/sdk/events/table.d.ts +15 -0
  42. package/dist/sdk/events/user.d.ts +36 -0
  43. package/dist/sdk/events/userGroup.d.ts +22 -0
  44. package/dist/sdk/index.d.ts +1 -0
  45. package/dist/sdk/index.js +1 -0
  46. package/dist/sdk/index.js.map +1 -1
  47. package/dist/sdk/licensing/feature.d.ts +1 -0
  48. package/dist/sdk/licensing/feature.js +1 -0
  49. package/dist/sdk/licensing/feature.js.map +1 -1
  50. package/dist/tsconfig.build.tsbuildinfo +1 -1
  51. package/package.json +2 -2
  52. package/src/api/web/global/auditLogs.ts +44 -0
  53. package/src/api/web/global/index.ts +1 -0
  54. package/src/api/web/index.ts +1 -0
  55. package/src/api/web/pagination.ts +27 -0
  56. package/src/documents/global/auditLogs.ts +13 -0
  57. package/src/documents/global/index.ts +1 -0
  58. package/src/sdk/auditLogs.ts +21 -0
  59. package/src/sdk/context.ts +2 -1
  60. package/src/sdk/db.ts +19 -1
  61. package/src/sdk/events/app.ts +33 -0
  62. package/src/sdk/events/auditLog.ts +10 -0
  63. package/src/sdk/events/auth.ts +6 -0
  64. package/src/sdk/events/automation.ts +12 -0
  65. package/src/sdk/events/backup.ts +2 -0
  66. package/src/sdk/events/event.ts +189 -0
  67. package/src/sdk/events/identification.ts +6 -0
  68. package/src/sdk/events/index.ts +1 -0
  69. package/src/sdk/events/screen.ts +6 -0
  70. package/src/sdk/events/table.ts +15 -0
  71. package/src/sdk/events/user.ts +38 -1
  72. package/src/sdk/events/userGroup.ts +23 -0
  73. package/src/sdk/index.ts +1 -0
  74. package/src/sdk/licensing/feature.ts +1 -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 interface AuditLogEnriched {
21
+ app?: App | {
22
+ _id: string;
23
+ status: AuditLogResourceStatus;
24
+ };
25
+ user: User | {
26
+ _id: string;
27
+ status: AuditLogResourceStatus;
28
+ };
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"}
@@ -1,3 +1,4 @@
1
1
  export * from "./environmentVariables";
2
+ export * from "./auditLogs";
2
3
  export * from "./events";
3
4
  export * from "./configs";
@@ -15,6 +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);
19
20
  __exportStar(require("./configs"), exports);
20
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;AACxB,4CAAyB"}
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"}
@@ -0,0 +1,11 @@
1
+ import { Document } from "../document";
2
+ import { Event } from "../../sdk";
3
+ export declare const AuditLogSystemUser = "SYSTEM";
4
+ export interface AuditLogDoc extends Document {
5
+ appId?: string;
6
+ event: Event;
7
+ userId: string;
8
+ timestamp: string;
9
+ metadata: any;
10
+ name: string;
11
+ }
@@ -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"}
@@ -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"}
@@ -0,0 +1,14 @@
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
+ };
@@ -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":""}
@@ -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;
@@ -4,6 +4,9 @@ export interface AutomationCreatedEvent extends BaseEvent {
4
4
  automationId: string;
5
5
  triggerId: string;
6
6
  triggerType: string;
7
+ audited: {
8
+ name: string;
9
+ };
7
10
  }
8
11
  export interface AutomationTriggerUpdatedEvent extends BaseEvent {
9
12
  appId: string;
@@ -16,6 +19,9 @@ export interface AutomationDeletedEvent extends BaseEvent {
16
19
  automationId: string;
17
20
  triggerId: string;
18
21
  triggerType: string;
22
+ audited: {
23
+ name: string;
24
+ };
19
25
  }
20
26
  export interface AutomationTestedEvent extends BaseEvent {
21
27
  appId: string;
@@ -30,6 +36,9 @@ export interface AutomationStepCreatedEvent extends BaseEvent {
30
36
  triggerType: string;
31
37
  stepId: string;
32
38
  stepType: string;
39
+ audited: {
40
+ name: string;
41
+ };
33
42
  }
34
43
  export interface AutomationStepDeletedEvent extends BaseEvent {
35
44
  appId: string;
@@ -38,6 +47,9 @@ export interface AutomationStepDeletedEvent extends BaseEvent {
38
47
  triggerType: string;
39
48
  stepId: string;
40
49
  stepType: string;
50
+ audited: {
51
+ name: string;
52
+ };
41
53
  }
42
54
  export interface AutomationsRunEvent extends BaseEvent {
43
55
  count: number;
@@ -4,10 +4,12 @@ export interface AppBackupRestoreEvent extends BaseEvent {
4
4
  appId: string;
5
5
  restoreId: string;
6
6
  backupCreatedAt: string;
7
+ name: string;
7
8
  }
8
9
  export interface AppBackupTriggeredEvent extends BaseEvent {
9
10
  backupId: string;
10
11
  appId: string;
11
12
  trigger: AppBackupTrigger;
12
13
  type: AppBackupType;
14
+ name: string;
13
15
  }
@@ -121,8 +121,11 @@ export declare enum Event {
121
121
  APP_BACKUP_TRIGGERED = "app:backup:triggered",
122
122
  ENVIRONMENT_VARIABLE_CREATED = "environment_variable:created",
123
123
  ENVIRONMENT_VARIABLE_DELETED = "environment_variable:deleted",
124
- ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable:upgrade_panel_opened"
124
+ ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable:upgrade_panel_opened",
125
+ AUDIT_LOGS_FILTERED = "audit_log:filtered",
126
+ AUDIT_LOGS_DOWNLOADED = "audit_log:downloaded"
125
127
  }
128
+ export declare const AuditedEventFriendlyName: Record<Event, string | undefined>;
126
129
  export interface BaseEvent {
127
130
  version?: string;
128
131
  service?: string;
@@ -131,5 +134,8 @@ export interface BaseEvent {
131
134
  installationId?: string;
132
135
  tenantId?: string;
133
136
  hosting?: Hosting;
137
+ audited?: {
138
+ [key: string]: any;
139
+ };
134
140
  }
135
141
  export declare type TableExportFormat = "json" | "csv";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Event = void 0;
3
+ exports.AuditedEventFriendlyName = exports.Event = void 0;
4
4
  var Event;
5
5
  (function (Event) {
6
6
  // USER
@@ -154,5 +154,164 @@ var Event;
154
154
  Event["ENVIRONMENT_VARIABLE_CREATED"] = "environment_variable:created";
155
155
  Event["ENVIRONMENT_VARIABLE_DELETED"] = "environment_variable:deleted";
156
156
  Event["ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED"] = "environment_variable:upgrade_panel_opened";
157
+ // AUDIT LOG
158
+ Event["AUDIT_LOGS_FILTERED"] = "audit_log:filtered";
159
+ Event["AUDIT_LOGS_DOWNLOADED"] = "audit_log:downloaded";
157
160
  })(Event = exports.Event || (exports.Event = {}));
161
+ // all events that are not audited have been added to this record as undefined, this means
162
+ // that Typescript can protect us against new events being added and auditing of those
163
+ // events not being considered. This might be a little ugly, but provides a level of
164
+ // Typescript build protection for the audit log feature, any new event also needs to be
165
+ // added to this map, during which the developer will need to consider if it should be
166
+ // a user facing event or not.
167
+ exports.AuditedEventFriendlyName = {
168
+ // USER
169
+ [Event.USER_CREATED]: `User "{{ email }}" created`,
170
+ [Event.USER_UPDATED]: `User "{{ email }}" updated`,
171
+ [Event.USER_DELETED]: `User "{{ email }}" deleted`,
172
+ [Event.USER_PERMISSION_ADMIN_ASSIGNED]: `User "{{ email }}" admin role assigned`,
173
+ [Event.USER_PERMISSION_ADMIN_REMOVED]: `User "{{ email }}" admin role removed`,
174
+ [Event.USER_PERMISSION_BUILDER_ASSIGNED]: `User "{{ email }}" builder role assigned`,
175
+ [Event.USER_PERMISSION_BUILDER_REMOVED]: `User "{{ email }}" builder role removed`,
176
+ [Event.USER_INVITED]: `User "{{ email }}" invited`,
177
+ [Event.USER_INVITED_ACCEPTED]: `User "{{ email }}" accepted invite`,
178
+ [Event.USER_PASSWORD_UPDATED]: `User "{{ email }}" password updated`,
179
+ [Event.USER_PASSWORD_RESET_REQUESTED]: `User "{{ email }}" password reset requested`,
180
+ [Event.USER_PASSWORD_RESET]: `User "{{ email }}" password reset`,
181
+ [Event.USER_GROUP_CREATED]: `User group "{{ name }}" created`,
182
+ [Event.USER_GROUP_UPDATED]: `User group "{{ name }}" updated`,
183
+ [Event.USER_GROUP_DELETED]: `User group "{{ name }}" deleted`,
184
+ [Event.USER_GROUP_USERS_ADDED]: `User group "{{ name }}" {{ count }} users added`,
185
+ [Event.USER_GROUP_USERS_REMOVED]: `User group "{{ name }}" {{ count }} users removed`,
186
+ [Event.USER_GROUP_PERMISSIONS_EDITED]: `User group "{{ name }}" permissions edited`,
187
+ [Event.USER_PASSWORD_FORCE_RESET]: undefined,
188
+ [Event.USER_GROUP_ONBOARDING]: undefined,
189
+ [Event.USER_ONBOARDING_COMPLETE]: undefined,
190
+ // EMAIL
191
+ [Event.EMAIL_SMTP_CREATED]: `Email configuration created`,
192
+ [Event.EMAIL_SMTP_UPDATED]: `Email configuration updated`,
193
+ // AUTH
194
+ [Event.AUTH_SSO_CREATED]: `SSO configuration created`,
195
+ [Event.AUTH_SSO_UPDATED]: `SSO configuration updated`,
196
+ [Event.AUTH_SSO_ACTIVATED]: `SSO configuration activated`,
197
+ [Event.AUTH_SSO_DEACTIVATED]: `SSO configuration deactivated`,
198
+ [Event.AUTH_LOGIN]: `User "{{ email }}" logged in`,
199
+ [Event.AUTH_LOGOUT]: `User "{{ email }}" logged out`,
200
+ // ORG
201
+ [Event.ORG_NAME_UPDATED]: `Organisation name updated`,
202
+ [Event.ORG_LOGO_UPDATED]: `Organisation logo updated`,
203
+ [Event.ORG_PLATFORM_URL_UPDATED]: `Organisation platform URL updated`,
204
+ // APP
205
+ [Event.APP_CREATED]: `App "{{ name }}" created`,
206
+ [Event.APP_UPDATED]: `App "{{ name }}" updated`,
207
+ [Event.APP_DELETED]: `App "{{ name }}" deleted`,
208
+ [Event.APP_PUBLISHED]: `App "{{ name }}" published`,
209
+ [Event.APP_UNPUBLISHED]: `App "{{ name }}" unpublished`,
210
+ [Event.APP_TEMPLATE_IMPORTED]: `App "{{ name }}" template imported`,
211
+ [Event.APP_FILE_IMPORTED]: `App "{{ name }}" file imported`,
212
+ [Event.APP_VERSION_UPDATED]: `App "{{ name }}" version updated`,
213
+ [Event.APP_VERSION_REVERTED]: `App "{{ name }}" version reverted`,
214
+ [Event.APP_REVERTED]: `App "{{ name }}" reverted`,
215
+ [Event.APP_EXPORTED]: `App "{{ name }}" exported`,
216
+ [Event.APP_BACKUP_RESTORED]: `App backup "{{ name }}" restored`,
217
+ [Event.APP_BACKUP_TRIGGERED]: `App backup "{{ name }}" triggered`,
218
+ // DATASOURCE
219
+ [Event.DATASOURCE_CREATED]: `Datasource created`,
220
+ [Event.DATASOURCE_UPDATED]: `Datasource updated`,
221
+ [Event.DATASOURCE_DELETED]: `Datasource deleted`,
222
+ // QUERY
223
+ [Event.QUERY_CREATED]: `Query created`,
224
+ [Event.QUERY_UPDATED]: `Query updated`,
225
+ [Event.QUERY_DELETED]: `Query deleted`,
226
+ [Event.QUERY_IMPORT]: `Query import`,
227
+ [Event.QUERIES_RUN]: undefined,
228
+ [Event.QUERY_PREVIEWED]: undefined,
229
+ // TABLE
230
+ [Event.TABLE_CREATED]: `Table "{{ name }}" created`,
231
+ [Event.TABLE_UPDATED]: `Table "{{ name }}" updated`,
232
+ [Event.TABLE_DELETED]: `Table "{{ name }}" deleted`,
233
+ [Event.TABLE_EXPORTED]: `Table "{{ name }}" exported`,
234
+ [Event.TABLE_IMPORTED]: `Table "{{ name }}" imported`,
235
+ [Event.TABLE_DATA_IMPORTED]: `Data imported to table`,
236
+ // ROWS
237
+ [Event.ROWS_CREATED]: `Rows created`,
238
+ [Event.ROWS_IMPORTED]: `Rows imported`,
239
+ // AUTOMATION
240
+ [Event.AUTOMATION_CREATED]: `Automation "{{ name }}" created`,
241
+ [Event.AUTOMATION_DELETED]: `Automation "{{ name }}" deleted`,
242
+ [Event.AUTOMATION_STEP_CREATED]: `Automation "{{ name }}" step added`,
243
+ [Event.AUTOMATION_STEP_DELETED]: `Automation "{{ name }}" step removed`,
244
+ [Event.AUTOMATION_TESTED]: undefined,
245
+ [Event.AUTOMATIONS_RUN]: undefined,
246
+ [Event.AUTOMATION_TRIGGER_UPDATED]: undefined,
247
+ // SCREEN
248
+ [Event.SCREEN_CREATED]: `Screen "{{ name }}" created`,
249
+ [Event.SCREEN_DELETED]: `Screen "{{ name }}" deleted`,
250
+ // COMPONENT
251
+ [Event.COMPONENT_CREATED]: `Component created`,
252
+ [Event.COMPONENT_DELETED]: `Component deleted`,
253
+ // ENVIRONMENT VARIABLE
254
+ [Event.ENVIRONMENT_VARIABLE_CREATED]: `Environment variable created`,
255
+ [Event.ENVIRONMENT_VARIABLE_DELETED]: `Environment variable deleted`,
256
+ [Event.ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED]: undefined,
257
+ // PLUGIN
258
+ [Event.PLUGIN_IMPORTED]: `Plugin imported`,
259
+ [Event.PLUGIN_DELETED]: `Plugin deleted`,
260
+ [Event.PLUGIN_INIT]: undefined,
261
+ // ROLE - NOT AUDITED
262
+ [Event.ROLE_CREATED]: undefined,
263
+ [Event.ROLE_UPDATED]: undefined,
264
+ [Event.ROLE_DELETED]: undefined,
265
+ [Event.ROLE_ASSIGNED]: undefined,
266
+ [Event.ROLE_UNASSIGNED]: undefined,
267
+ // LICENSE - NOT AUDITED
268
+ [Event.LICENSE_PLAN_CHANGED]: undefined,
269
+ [Event.LICENSE_TIER_CHANGED]: undefined,
270
+ [Event.LICENSE_ACTIVATED]: undefined,
271
+ [Event.LICENSE_PAYMENT_FAILED]: undefined,
272
+ [Event.LICENSE_PAYMENT_RECOVERED]: undefined,
273
+ [Event.LICENSE_CHECKOUT_OPENED]: undefined,
274
+ [Event.LICENSE_CHECKOUT_SUCCESS]: undefined,
275
+ [Event.LICENSE_PORTAL_OPENED]: undefined,
276
+ // ACCOUNT - NOT AUDITED
277
+ [Event.ACCOUNT_CREATED]: undefined,
278
+ [Event.ACCOUNT_DELETED]: undefined,
279
+ [Event.ACCOUNT_VERIFIED]: undefined,
280
+ // BACKFILL - NOT AUDITED
281
+ [Event.APP_BACKFILL_SUCCEEDED]: undefined,
282
+ [Event.APP_BACKFILL_FAILED]: undefined,
283
+ [Event.TENANT_BACKFILL_SUCCEEDED]: undefined,
284
+ [Event.TENANT_BACKFILL_FAILED]: undefined,
285
+ [Event.INSTALLATION_BACKFILL_SUCCEEDED]: undefined,
286
+ [Event.INSTALLATION_BACKFILL_FAILED]: undefined,
287
+ // LAYOUT - NOT AUDITED
288
+ [Event.LAYOUT_CREATED]: undefined,
289
+ [Event.LAYOUT_DELETED]: undefined,
290
+ // VIEW - NOT AUDITED
291
+ [Event.VIEW_CREATED]: undefined,
292
+ [Event.VIEW_UPDATED]: undefined,
293
+ [Event.VIEW_DELETED]: undefined,
294
+ [Event.VIEW_EXPORTED]: undefined,
295
+ [Event.VIEW_FILTER_CREATED]: undefined,
296
+ [Event.VIEW_FILTER_UPDATED]: undefined,
297
+ [Event.VIEW_FILTER_DELETED]: undefined,
298
+ [Event.VIEW_CALCULATION_CREATED]: undefined,
299
+ [Event.VIEW_CALCULATION_UPDATED]: undefined,
300
+ [Event.VIEW_CALCULATION_DELETED]: undefined,
301
+ // SERVED - NOT AUDITED
302
+ [Event.SERVED_BUILDER]: undefined,
303
+ [Event.SERVED_APP]: undefined,
304
+ [Event.SERVED_APP_PREVIEW]: undefined,
305
+ // ANALYTICS - NOT AUDITED
306
+ [Event.ANALYTICS_OPT_OUT]: undefined,
307
+ [Event.ANALYTICS_OPT_IN]: undefined,
308
+ // INSTALLATION - NOT AUDITED
309
+ [Event.INSTALLATION_VERSION_CHECKED]: undefined,
310
+ [Event.INSTALLATION_VERSION_UPGRADED]: undefined,
311
+ [Event.INSTALLATION_VERSION_DOWNGRADED]: undefined,
312
+ [Event.INSTALLATION_FIRST_STARTUP]: undefined,
313
+ // AUDIT LOG - NOT AUDITED
314
+ [Event.AUDIT_LOGS_FILTERED]: undefined,
315
+ [Event.AUDIT_LOGS_DOWNLOADED]: undefined,
316
+ };
158
317
  //# sourceMappingURL=event.js.map