@budibase/types 2.9.19 → 2.9.20

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 (258) hide show
  1. package/dist/api/account/accounts.d.ts +17 -0
  2. package/dist/api/account/index.d.ts +4 -0
  3. package/dist/api/account/license.d.ts +31 -0
  4. package/dist/api/account/status.d.ts +7 -0
  5. package/{src/api/account/user.ts → dist/api/account/user.d.ts} +3 -4
  6. package/dist/api/index.d.ts +2 -0
  7. package/dist/api/web/analytics.d.ts +9 -0
  8. package/{src/api/web/app/backup.ts → dist/api/web/app/backup.d.ts} +10 -14
  9. package/{src/api/web/app/datasource.ts → dist/api/web/app/datasource.d.ts} +13 -21
  10. package/dist/api/web/app/index.d.ts +6 -0
  11. package/dist/api/web/app/row.d.ts +8 -0
  12. package/dist/api/web/app/rows.d.ts +11 -0
  13. package/dist/api/web/app/table.d.ts +12 -0
  14. package/dist/api/web/app/view.d.ts +10 -0
  15. package/dist/api/web/auth.d.ts +22 -0
  16. package/dist/api/web/debug.d.ts +11 -0
  17. package/dist/api/web/errors.d.ts +6 -0
  18. package/dist/api/web/global/auditLogs.d.ts +39 -0
  19. package/{src/api/web/global/configs.ts → dist/api/web/global/configs.d.ts} +11 -15
  20. package/{src/api/web/global/environmentVariables.ts → dist/api/web/global/environmentVariables.d.ts} +7 -10
  21. package/dist/api/web/global/events.d.ts +6 -0
  22. package/dist/api/web/global/index.d.ts +6 -0
  23. package/{src/api/web/global/license.ts → dist/api/web/global/license.d.ts} +5 -15
  24. package/dist/api/web/global/scim/groups.d.ts +27 -0
  25. package/dist/api/web/global/scim/index.d.ts +3 -0
  26. package/dist/api/web/global/scim/shared.d.ts +12 -0
  27. package/dist/api/web/global/scim/users.d.ts +48 -0
  28. package/dist/api/web/index.d.ts +10 -0
  29. package/dist/api/web/pagination.d.ts +23 -0
  30. package/dist/api/web/schedule.d.ts +10 -0
  31. package/dist/api/web/system/environment.d.ts +8 -0
  32. package/dist/api/web/system/index.d.ts +1 -0
  33. package/dist/api/web/user.d.ts +84 -0
  34. package/dist/core/index.d.ts +1 -0
  35. package/dist/core/installation.d.ts +4 -0
  36. package/dist/documents/account/account.d.ts +78 -0
  37. package/dist/documents/account/index.d.ts +2 -0
  38. package/{src/documents/account/user.ts → dist/documents/account/user.d.ts} +5 -6
  39. package/dist/documents/app/app.d.ts +61 -0
  40. package/dist/documents/app/automation.d.ts +192 -0
  41. package/dist/documents/app/backup.d.ts +63 -0
  42. package/dist/documents/app/component.d.ts +10 -0
  43. package/dist/documents/app/datasource.d.ts +49 -0
  44. package/dist/documents/app/index.d.ts +16 -0
  45. package/dist/documents/app/layout.d.ts +4 -0
  46. package/dist/documents/app/links.d.ts +19 -0
  47. package/dist/documents/app/query.d.ts +49 -0
  48. package/dist/documents/app/role.d.ts +9 -0
  49. package/dist/documents/app/row.d.ts +31 -0
  50. package/dist/documents/app/screen.d.ts +22 -0
  51. package/dist/documents/app/table/constants.d.ts +8 -0
  52. package/dist/documents/app/table/index.d.ts +3 -0
  53. package/dist/documents/app/table/schema.d.ts +71 -0
  54. package/dist/documents/app/table/table.d.ts +33 -0
  55. package/dist/documents/app/user.d.ts +5 -0
  56. package/dist/documents/app/view.d.ts +59 -0
  57. package/dist/documents/app/webhook.d.ts +13 -0
  58. package/dist/documents/document.d.ts +47 -0
  59. package/dist/documents/global/auditLogs.d.ts +16 -0
  60. package/dist/documents/global/config.d.ts +112 -0
  61. package/dist/documents/global/environmentVariables.d.ts +12 -0
  62. package/dist/documents/global/index.d.ts +9 -0
  63. package/dist/documents/global/plugin.d.ts +34 -0
  64. package/dist/documents/global/quotas.d.ts +63 -0
  65. package/dist/documents/global/schedule.d.ts +21 -0
  66. package/dist/documents/global/templates.d.ts +8 -0
  67. package/dist/documents/global/user.d.ts +74 -0
  68. package/dist/documents/global/userGroup.d.ts +32 -0
  69. package/dist/documents/index.d.ts +6 -0
  70. package/dist/documents/platform/accounts.d.ts +4 -0
  71. package/dist/documents/platform/index.d.ts +4 -0
  72. package/dist/documents/platform/info.d.ts +8 -0
  73. package/dist/documents/platform/tenants.d.ts +4 -0
  74. package/dist/documents/platform/users.d.ts +15 -0
  75. package/dist/documents/pouch.d.ts +28 -0
  76. package/dist/index.d.ts +5 -0
  77. package/dist/index.js +1159 -0
  78. package/dist/index.js.map +7 -0
  79. package/dist/index.js.meta.json +1 -0
  80. package/dist/sdk/auditLogs.d.ts +15 -0
  81. package/dist/sdk/auth.d.ts +30 -0
  82. package/dist/sdk/automations/index.d.ts +13 -0
  83. package/dist/sdk/cli/constants.d.ts +18 -0
  84. package/dist/sdk/cli/index.d.ts +1 -0
  85. package/dist/sdk/context.d.ts +18 -0
  86. package/dist/sdk/datasources.d.ts +159 -0
  87. package/dist/sdk/db.d.ts +91 -0
  88. package/dist/sdk/environmentVariables.d.ts +4 -0
  89. package/{src/sdk/events/account.ts → dist/sdk/events/account.d.ts} +6 -9
  90. package/dist/sdk/events/app.d.ts +74 -0
  91. package/dist/sdk/events/auditLog.d.ts +8 -0
  92. package/dist/sdk/events/auth.d.ts +29 -0
  93. package/dist/sdk/events/automation.d.ts +56 -0
  94. package/{src/sdk/events/backfill.ts → dist/sdk/events/backfill.d.ts} +26 -34
  95. package/dist/sdk/events/backup.d.ts +15 -0
  96. package/dist/sdk/events/datasource.d.ts +16 -0
  97. package/dist/sdk/events/email.d.ts +5 -0
  98. package/{src/sdk/events/environmentVariable.ts → dist/sdk/events/environmentVariable.d.ts} +5 -8
  99. package/dist/sdk/events/event.d.ts +155 -0
  100. package/dist/sdk/events/identification.d.ts +45 -0
  101. package/dist/sdk/events/index.d.ts +25 -0
  102. package/{src/sdk/events/layout.ts → dist/sdk/events/layout.d.ts} +3 -5
  103. package/dist/sdk/events/license.d.ts +28 -0
  104. package/dist/sdk/events/plugin.d.ts +23 -0
  105. package/dist/sdk/events/query.d.ts +34 -0
  106. package/dist/sdk/events/role.d.ts +24 -0
  107. package/{src/sdk/events/rows.ts → dist/sdk/events/rows.d.ts} +4 -6
  108. package/dist/sdk/events/screen.d.ts +17 -0
  109. package/{src/sdk/events/serve.ts → dist/sdk/events/serve.d.ts} +7 -10
  110. package/dist/sdk/events/table.d.ts +32 -0
  111. package/dist/sdk/events/user.d.ts +79 -0
  112. package/dist/sdk/events/userGroup.d.ts +49 -0
  113. package/{src/sdk/events/version.ts → dist/sdk/events/version.d.ts} +4 -6
  114. package/{src/sdk/events/view.ts → dist/sdk/events/view.d.ts} +16 -26
  115. package/dist/sdk/featureFlag.d.ts +6 -0
  116. package/dist/sdk/hosting.d.ts +4 -0
  117. package/dist/sdk/index.d.ts +21 -0
  118. package/dist/sdk/koa.d.ts +44 -0
  119. package/dist/sdk/licensing/billing.d.ts +21 -0
  120. package/dist/sdk/licensing/feature.d.ts +16 -0
  121. package/dist/sdk/licensing/index.d.ts +5 -0
  122. package/dist/sdk/licensing/license.d.ts +17 -0
  123. package/dist/sdk/licensing/plan.d.ts +41 -0
  124. package/dist/sdk/licensing/quota.d.ts +69 -0
  125. package/dist/sdk/locks.d.ts +47 -0
  126. package/dist/sdk/middleware/index.d.ts +2 -0
  127. package/dist/sdk/middleware/matchers.d.ts +21 -0
  128. package/dist/sdk/middleware/tenancy.d.ts +12 -0
  129. package/dist/sdk/migrations.d.ts +46 -0
  130. package/dist/sdk/permissions.d.ts +17 -0
  131. package/dist/sdk/search.d.ts +94 -0
  132. package/dist/sdk/sso.d.ts +24 -0
  133. package/dist/sdk/user.d.ts +5 -0
  134. package/dist/sdk/websocket.d.ts +9 -0
  135. package/dist/shared/index.d.ts +1 -0
  136. package/dist/shared/typeUtils.d.ts +7 -0
  137. package/package.json +4 -10
  138. package/src/api/account/accounts.ts +0 -22
  139. package/src/api/account/index.ts +0 -4
  140. package/src/api/account/license.ts +0 -39
  141. package/src/api/account/status.ts +0 -7
  142. package/src/api/index.ts +0 -2
  143. package/src/api/public/.keep +0 -0
  144. package/src/api/web/analytics.ts +0 -10
  145. package/src/api/web/app/index.ts +0 -6
  146. package/src/api/web/app/row.ts +0 -11
  147. package/src/api/web/app/rows.ts +0 -13
  148. package/src/api/web/app/table.ts +0 -13
  149. package/src/api/web/app/view.ts +0 -15
  150. package/src/api/web/auth.ts +0 -26
  151. package/src/api/web/debug.ts +0 -11
  152. package/src/api/web/errors.ts +0 -6
  153. package/src/api/web/global/auditLogs.ts +0 -51
  154. package/src/api/web/global/events.ts +0 -7
  155. package/src/api/web/global/index.ts +0 -6
  156. package/src/api/web/global/scim/groups.ts +0 -30
  157. package/src/api/web/global/scim/index.ts +0 -3
  158. package/src/api/web/global/scim/shared.ts +0 -14
  159. package/src/api/web/global/scim/users.ts +0 -53
  160. package/src/api/web/index.ts +0 -10
  161. package/src/api/web/pagination.ts +0 -27
  162. package/src/api/web/schedule.ts +0 -15
  163. package/src/api/web/system/environment.ts +0 -8
  164. package/src/api/web/system/index.ts +0 -1
  165. package/src/api/web/user.ts +0 -87
  166. package/src/core/index.ts +0 -1
  167. package/src/core/installation.ts +0 -4
  168. package/src/documents/account/account.ts +0 -108
  169. package/src/documents/account/index.ts +0 -2
  170. package/src/documents/app/app.ts +0 -69
  171. package/src/documents/app/automation.ts +0 -222
  172. package/src/documents/app/backup.ts +0 -71
  173. package/src/documents/app/component.ts +0 -9
  174. package/src/documents/app/datasource.ts +0 -56
  175. package/src/documents/app/index.ts +0 -16
  176. package/src/documents/app/layout.ts +0 -5
  177. package/src/documents/app/links.ts +0 -21
  178. package/src/documents/app/query.ts +0 -51
  179. package/src/documents/app/role.ts +0 -8
  180. package/src/documents/app/row.ts +0 -35
  181. package/src/documents/app/screen.ts +0 -25
  182. package/src/documents/app/table/constants.ts +0 -9
  183. package/src/documents/app/table/index.ts +0 -3
  184. package/src/documents/app/table/schema.ts +0 -98
  185. package/src/documents/app/table/table.ts +0 -30
  186. package/src/documents/app/user.ts +0 -6
  187. package/src/documents/app/view.ts +0 -66
  188. package/src/documents/app/webhook.ts +0 -15
  189. package/src/documents/document.ts +0 -51
  190. package/src/documents/global/auditLogs.ts +0 -19
  191. package/src/documents/global/config.ts +0 -137
  192. package/src/documents/global/environmentVariables.ts +0 -20
  193. package/src/documents/global/index.ts +0 -9
  194. package/src/documents/global/plugin.ts +0 -38
  195. package/src/documents/global/quotas.ts +0 -81
  196. package/src/documents/global/schedule.ts +0 -32
  197. package/src/documents/global/templates.ts +0 -9
  198. package/src/documents/global/user.ts +0 -95
  199. package/src/documents/global/userGroup.ts +0 -36
  200. package/src/documents/index.ts +0 -6
  201. package/src/documents/platform/accounts.ts +0 -5
  202. package/src/documents/platform/index.ts +0 -4
  203. package/src/documents/platform/info.ts +0 -9
  204. package/src/documents/platform/tenants.ts +0 -5
  205. package/src/documents/platform/users.ts +0 -18
  206. package/src/documents/pouch.ts +0 -32
  207. package/src/index.ts +0 -5
  208. package/src/sdk/auditLogs.ts +0 -22
  209. package/src/sdk/auth.ts +0 -37
  210. package/src/sdk/automations/index.ts +0 -16
  211. package/src/sdk/cli/constants.ts +0 -21
  212. package/src/sdk/cli/index.ts +0 -1
  213. package/src/sdk/context.ts +0 -22
  214. package/src/sdk/datasources.ts +0 -181
  215. package/src/sdk/db.ts +0 -116
  216. package/src/sdk/environmentVariables.ts +0 -4
  217. package/src/sdk/events/app.ts +0 -85
  218. package/src/sdk/events/auditLog.ts +0 -10
  219. package/src/sdk/events/auth.ts +0 -36
  220. package/src/sdk/events/automation.ts +0 -63
  221. package/src/sdk/events/backup.ts +0 -17
  222. package/src/sdk/events/datasource.ts +0 -19
  223. package/src/sdk/events/email.ts +0 -5
  224. package/src/sdk/events/event.ts +0 -424
  225. package/src/sdk/events/identification.ts +0 -60
  226. package/src/sdk/events/index.ts +0 -25
  227. package/src/sdk/events/license.ts +0 -36
  228. package/src/sdk/events/plugin.ts +0 -26
  229. package/src/sdk/events/query.ts +0 -40
  230. package/src/sdk/events/role.ts +0 -29
  231. package/src/sdk/events/screen.ts +0 -19
  232. package/src/sdk/events/table.ts +0 -37
  233. package/src/sdk/events/user.ts +0 -92
  234. package/src/sdk/events/userGroup.ts +0 -56
  235. package/src/sdk/featureFlag.ts +0 -7
  236. package/src/sdk/hosting.ts +0 -4
  237. package/src/sdk/index.ts +0 -21
  238. package/src/sdk/koa.ts +0 -50
  239. package/src/sdk/licensing/billing.ts +0 -24
  240. package/src/sdk/licensing/feature.ts +0 -16
  241. package/src/sdk/licensing/index.ts +0 -5
  242. package/src/sdk/licensing/license.ts +0 -20
  243. package/src/sdk/licensing/plan.ts +0 -47
  244. package/src/sdk/licensing/quota.ts +0 -99
  245. package/src/sdk/locks.ts +0 -50
  246. package/src/sdk/middleware/index.ts +0 -2
  247. package/src/sdk/middleware/matchers.ts +0 -22
  248. package/src/sdk/middleware/tenancy.ts +0 -13
  249. package/src/sdk/migrations.ts +0 -55
  250. package/src/sdk/permissions.ts +0 -19
  251. package/src/sdk/search.ts +0 -101
  252. package/src/sdk/sso.ts +0 -37
  253. package/src/sdk/user.ts +0 -5
  254. package/src/sdk/websocket.ts +0 -9
  255. package/src/shared/index.ts +0 -1
  256. package/src/shared/typeUtils.ts +0 -9
  257. package/tsconfig.build.json +0 -18
  258. package/tsconfig.json +0 -10
@@ -1,424 +0,0 @@
1
- import { Hosting } from "../hosting"
2
- import { Group, Identity } from "./identification"
3
-
4
- export enum Event {
5
- // USER
6
- USER_CREATED = "user:created",
7
- USER_UPDATED = "user:updated",
8
- USER_DELETED = "user:deleted",
9
-
10
- // USER / ONBOARDING
11
- USER_ONBOARDING_COMPLETE = "user:onboarding:complete",
12
-
13
- // USER / PERMISSIONS
14
- USER_PERMISSION_ADMIN_ASSIGNED = "user:admin:assigned",
15
- USER_PERMISSION_ADMIN_REMOVED = "user:admin:removed",
16
- USER_PERMISSION_BUILDER_ASSIGNED = "user:builder:assigned",
17
- USER_PERMISSION_BUILDER_REMOVED = "user:builder:removed",
18
-
19
- // USER / INVITE
20
- USER_INVITED = "user:invited",
21
- USER_INVITED_ACCEPTED = "user:invite:accepted",
22
-
23
- // USER / PASSWORD
24
- USER_PASSWORD_FORCE_RESET = "user:password:force:reset",
25
- USER_PASSWORD_UPDATED = "user:password:updated",
26
- USER_PASSWORD_RESET_REQUESTED = "user:password:reset:requested",
27
- USER_PASSWORD_RESET = "user:password:reset",
28
-
29
- // USER / COLLABORATION
30
- USER_DATA_COLLABORATION = "user:data:collaboration",
31
-
32
- // EMAIL
33
- EMAIL_SMTP_CREATED = "email:smtp:created",
34
- EMAIL_SMTP_UPDATED = "email:smtp:updated",
35
-
36
- // AUTH
37
- AUTH_SSO_CREATED = "auth:sso:created",
38
- AUTH_SSO_UPDATED = "auth:sso:updated",
39
- AUTH_SSO_ACTIVATED = "auth:sso:activated",
40
- AUTH_SSO_DEACTIVATED = "auth:sso:deactivated",
41
- AUTH_LOGIN = "auth:login",
42
- AUTH_LOGOUT = "auth:logout",
43
-
44
- // ORG
45
- ORG_NAME_UPDATED = "org:info:name:updated",
46
- ORG_LOGO_UPDATED = "org:info:logo:updated",
47
- ORG_PLATFORM_URL_UPDATED = "org:platformurl:updated",
48
-
49
- // INSTALLATION
50
- INSTALLATION_VERSION_CHECKED = "installation:version:checked",
51
- INSTALLATION_VERSION_UPGRADED = "installation:version:upgraded",
52
- INSTALLATION_VERSION_DOWNGRADED = "installation:version:downgraded",
53
- INSTALLATION_FIRST_STARTUP = "installation:firstStartup",
54
-
55
- // ORG / ANALYTICS
56
- ANALYTICS_OPT_OUT = "analytics:opt:out",
57
- ANALYTICS_OPT_IN = "analytics:opt:in",
58
-
59
- // APP
60
- APP_CREATED = "app:created",
61
- APP_UPDATED = "app:updated",
62
- APP_DELETED = "app:deleted",
63
- APP_PUBLISHED = "app:published",
64
- APP_UNPUBLISHED = "app:unpublished",
65
- APP_TEMPLATE_IMPORTED = "app:template:imported",
66
- APP_FILE_IMPORTED = "app:file:imported",
67
- APP_VERSION_UPDATED = "app:version:updated",
68
- APP_VERSION_REVERTED = "app:version:reverted",
69
- APP_REVERTED = "app:reverted",
70
- APP_EXPORTED = "app:exported",
71
-
72
- // ROLE
73
- ROLE_CREATED = "role:created",
74
- ROLE_UPDATED = "role:updated",
75
- ROLE_DELETED = "role:deleted",
76
- ROLE_ASSIGNED = "role:assigned",
77
- ROLE_UNASSIGNED = "role:unassigned",
78
-
79
- // SERVE
80
- SERVED_BUILDER = "served:builder",
81
- SERVED_APP = "served:app",
82
- SERVED_APP_PREVIEW = "served:app:preview",
83
-
84
- // DATASOURCE
85
- DATASOURCE_CREATED = "datasource:created",
86
- DATASOURCE_UPDATED = "datasource:updated",
87
- DATASOURCE_DELETED = "datasource:deleted",
88
-
89
- // QUERY
90
- QUERY_CREATED = "query:created",
91
- QUERY_UPDATED = "query:updated",
92
- QUERY_DELETED = "query:deleted",
93
- QUERY_IMPORT = "query:import",
94
- QUERIES_RUN = "queries:run",
95
- QUERY_PREVIEWED = "query:previewed",
96
-
97
- // TABLE
98
- TABLE_CREATED = "table:created",
99
- TABLE_UPDATED = "table:updated",
100
- TABLE_DELETED = "table:deleted",
101
- TABLE_EXPORTED = "table:exported",
102
- TABLE_IMPORTED = "table:imported",
103
- TABLE_DATA_IMPORTED = "table:data:imported",
104
-
105
- // VIEW
106
- VIEW_CREATED = "view:created",
107
- VIEW_UPDATED = "view:updated",
108
- VIEW_DELETED = "view:deleted",
109
- VIEW_EXPORTED = "view:exported",
110
- VIEW_FILTER_CREATED = "view:filter:created",
111
- VIEW_FILTER_UPDATED = "view:filter:updated",
112
- VIEW_FILTER_DELETED = "view:filter:deleted",
113
- VIEW_CALCULATION_CREATED = "view:calculation:created",
114
- VIEW_CALCULATION_UPDATED = "view:calculation:updated",
115
- VIEW_CALCULATION_DELETED = "view:calculation:deleted",
116
-
117
- // ROWS
118
- ROWS_CREATED = "rows:created",
119
- ROWS_IMPORTED = "rows:imported",
120
-
121
- // COMPONENT
122
- COMPONENT_CREATED = "component:created",
123
- COMPONENT_DELETED = "component:deleted",
124
-
125
- // SCREEN
126
- SCREEN_CREATED = "screen:created",
127
- SCREEN_DELETED = "screen:deleted",
128
-
129
- // LAYOUT
130
- LAYOUT_CREATED = "layout:created",
131
- LAYOUT_DELETED = "layout:deleted",
132
-
133
- // AUTOMATION
134
- AUTOMATION_CREATED = "automation:created",
135
- AUTOMATION_DELETED = "automation:deleted",
136
- AUTOMATION_TESTED = "automation:tested",
137
- AUTOMATIONS_RUN = "automations:run",
138
- AUTOMATION_STEP_CREATED = "automation:step:created",
139
- AUTOMATION_STEP_DELETED = "automation:step:deleted",
140
- AUTOMATION_TRIGGER_UPDATED = "automation:trigger:updated",
141
-
142
- // LICENSE
143
- LICENSE_PLAN_CHANGED = "license:plan:changed",
144
- LICENSE_ACTIVATED = "license:activated",
145
- LICENSE_PAYMENT_FAILED = "license:payment:failed",
146
- LICENSE_PAYMENT_RECOVERED = "license:payment:recovered",
147
- LICENSE_CHECKOUT_OPENED = "license:checkout:opened",
148
- LICENSE_CHECKOUT_SUCCESS = "license:checkout:success",
149
- LICENSE_PORTAL_OPENED = "license:portal:opened",
150
-
151
- // ACCOUNT
152
- ACCOUNT_CREATED = "account:created",
153
- ACCOUNT_DELETED = "account:deleted",
154
- ACCOUNT_VERIFIED = "account:verified",
155
-
156
- // BACKFILL
157
- APP_BACKFILL_SUCCEEDED = "app:backfill:succeeded",
158
- APP_BACKFILL_FAILED = "app:backfill:failed",
159
- TENANT_BACKFILL_SUCCEEDED = "tenant:backfill:succeeded",
160
- TENANT_BACKFILL_FAILED = "tenant:backfill:failed",
161
- INSTALLATION_BACKFILL_SUCCEEDED = "installation:backfill:succeeded",
162
- INSTALLATION_BACKFILL_FAILED = "installation:backfill:failed",
163
-
164
- // USER
165
- USER_GROUP_CREATED = "user_group:created",
166
- USER_GROUP_UPDATED = "user_group:updated",
167
- USER_GROUP_DELETED = "user_group:deleted",
168
- USER_GROUP_USERS_ADDED = "user_group:user_added",
169
- USER_GROUP_USERS_REMOVED = "user_group:users_deleted",
170
- USER_GROUP_PERMISSIONS_EDITED = "user_group:permissions_edited",
171
- USER_GROUP_ONBOARDING = "user_group:onboarding_added",
172
-
173
- // PLUGIN
174
- PLUGIN_INIT = "plugin:init",
175
- PLUGIN_IMPORTED = "plugin:imported",
176
- PLUGIN_DELETED = "plugin:deleted",
177
-
178
- // BACKUP
179
- APP_BACKUP_RESTORED = "app:backup:restored",
180
- APP_BACKUP_TRIGGERED = "app:backup:triggered",
181
-
182
- // ENVIRONMENT VARIABLE
183
- ENVIRONMENT_VARIABLE_CREATED = "environment_variable:created",
184
- ENVIRONMENT_VARIABLE_DELETED = "environment_variable:deleted",
185
- ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED = "environment_variable:upgrade_panel_opened",
186
-
187
- // AUDIT LOG
188
- AUDIT_LOGS_FILTERED = "audit_log:filtered",
189
- AUDIT_LOGS_DOWNLOADED = "audit_log:downloaded",
190
- }
191
-
192
- export const UserGroupSyncEvents: Event[] = [
193
- Event.USER_CREATED,
194
- Event.USER_UPDATED,
195
- Event.USER_DELETED,
196
- Event.USER_PERMISSION_ADMIN_ASSIGNED,
197
- Event.USER_PERMISSION_ADMIN_REMOVED,
198
- Event.USER_PERMISSION_BUILDER_ASSIGNED,
199
- Event.USER_PERMISSION_BUILDER_REMOVED,
200
- Event.USER_GROUP_CREATED,
201
- Event.USER_GROUP_UPDATED,
202
- Event.USER_GROUP_DELETED,
203
- Event.USER_GROUP_USERS_ADDED,
204
- Event.USER_GROUP_USERS_REMOVED,
205
- Event.USER_GROUP_PERMISSIONS_EDITED,
206
- ]
207
-
208
- export const AsyncEvents: Event[] = [...UserGroupSyncEvents]
209
-
210
- // all events that are not audited have been added to this record as undefined, this means
211
- // that Typescript can protect us against new events being added and auditing of those
212
- // events not being considered. This might be a little ugly, but provides a level of
213
- // Typescript build protection for the audit log feature, any new event also needs to be
214
- // added to this map, during which the developer will need to consider if it should be
215
- // a user facing event or not.
216
- export const AuditedEventFriendlyName: Record<Event, string | undefined> = {
217
- // USER
218
- [Event.USER_CREATED]: `User "{{ email }}" created{{#if viaScim}} via SCIM{{/if}}`,
219
- [Event.USER_UPDATED]: `User "{{ email }}" updated{{#if viaScim}} via SCIM{{/if}}`,
220
- [Event.USER_DELETED]: `User "{{ email }}" deleted{{#if viaScim}} via SCIM{{/if}}`,
221
- [Event.USER_PERMISSION_ADMIN_ASSIGNED]: `User "{{ email }}" admin role assigned`,
222
- [Event.USER_PERMISSION_ADMIN_REMOVED]: `User "{{ email }}" admin role removed`,
223
- [Event.USER_PERMISSION_BUILDER_ASSIGNED]: `User "{{ email }}" builder role assigned`,
224
- [Event.USER_PERMISSION_BUILDER_REMOVED]: `User "{{ email }}" builder role removed`,
225
- [Event.USER_INVITED]: `User "{{ email }}" invited`,
226
- [Event.USER_INVITED_ACCEPTED]: `User "{{ email }}" accepted invite`,
227
- [Event.USER_PASSWORD_UPDATED]: `User "{{ email }}" password updated`,
228
- [Event.USER_PASSWORD_RESET_REQUESTED]: `User "{{ email }}" password reset requested`,
229
- [Event.USER_PASSWORD_RESET]: `User "{{ email }}" password reset`,
230
- [Event.USER_GROUP_CREATED]: `User group "{{ name }}" created{{#if viaScim}} via SCIM{{/if}}`,
231
- [Event.USER_GROUP_UPDATED]: `User group "{{ name }}" updated{{#if viaScim}} via SCIM{{/if}}`,
232
- [Event.USER_GROUP_DELETED]: `User group "{{ name }}" deleted{{#if viaScim}} via SCIM{{/if}}`,
233
- [Event.USER_GROUP_USERS_ADDED]: `User group "{{ name }}" {{ count }} users added{{#if viaScim}} via SCIM{{/if}}`,
234
- [Event.USER_GROUP_USERS_REMOVED]: `User group "{{ name }}" {{ count }} users removed{{#if viaScim}} via SCIM{{/if}}`,
235
- [Event.USER_GROUP_PERMISSIONS_EDITED]: `User group "{{ name }}" permissions edited`,
236
- [Event.USER_PASSWORD_FORCE_RESET]: undefined,
237
- [Event.USER_GROUP_ONBOARDING]: undefined,
238
- [Event.USER_ONBOARDING_COMPLETE]: undefined,
239
- [Event.USER_DATA_COLLABORATION]: undefined,
240
-
241
- // EMAIL
242
- [Event.EMAIL_SMTP_CREATED]: `Email configuration created`,
243
- [Event.EMAIL_SMTP_UPDATED]: `Email configuration updated`,
244
-
245
- // AUTH
246
- [Event.AUTH_SSO_CREATED]: `SSO configuration created`,
247
- [Event.AUTH_SSO_UPDATED]: `SSO configuration updated`,
248
- [Event.AUTH_SSO_ACTIVATED]: `SSO configuration activated`,
249
- [Event.AUTH_SSO_DEACTIVATED]: `SSO configuration deactivated`,
250
- [Event.AUTH_LOGIN]: `User "{{ email }}" logged in`,
251
- [Event.AUTH_LOGOUT]: `User "{{ email }}" logged out`,
252
-
253
- // ORG
254
- [Event.ORG_NAME_UPDATED]: `Organisation name updated`,
255
- [Event.ORG_LOGO_UPDATED]: `Organisation logo updated`,
256
- [Event.ORG_PLATFORM_URL_UPDATED]: `Organisation platform URL updated`,
257
-
258
- // APP
259
- [Event.APP_CREATED]: `App "{{ name }}" created`,
260
- [Event.APP_UPDATED]: `App "{{ name }}" updated`,
261
- [Event.APP_DELETED]: `App "{{ name }}" deleted`,
262
- [Event.APP_PUBLISHED]: `App "{{ name }}" published`,
263
- [Event.APP_UNPUBLISHED]: `App "{{ name }}" unpublished`,
264
- [Event.APP_TEMPLATE_IMPORTED]: `App "{{ name }}" template imported`,
265
- [Event.APP_FILE_IMPORTED]: `App "{{ name }}" file imported`,
266
- [Event.APP_VERSION_UPDATED]: `App "{{ name }}" version updated`,
267
- [Event.APP_VERSION_REVERTED]: `App "{{ name }}" version reverted`,
268
- [Event.APP_REVERTED]: `App "{{ name }}" reverted`,
269
- [Event.APP_EXPORTED]: `App "{{ name }}" exported`,
270
- [Event.APP_BACKUP_RESTORED]: `App backup "{{ name }}" restored`,
271
- [Event.APP_BACKUP_TRIGGERED]: `App backup "{{ name }}" triggered`,
272
-
273
- // DATASOURCE
274
- [Event.DATASOURCE_CREATED]: `Datasource created`,
275
- [Event.DATASOURCE_UPDATED]: `Datasource updated`,
276
- [Event.DATASOURCE_DELETED]: `Datasource deleted`,
277
-
278
- // QUERY
279
- [Event.QUERY_CREATED]: `Query created`,
280
- [Event.QUERY_UPDATED]: `Query updated`,
281
- [Event.QUERY_DELETED]: `Query deleted`,
282
- [Event.QUERY_IMPORT]: `Query import`,
283
- [Event.QUERIES_RUN]: undefined,
284
- [Event.QUERY_PREVIEWED]: undefined,
285
-
286
- // TABLE
287
- [Event.TABLE_CREATED]: `Table "{{ name }}" created`,
288
- [Event.TABLE_UPDATED]: `Table "{{ name }}" updated`,
289
- [Event.TABLE_DELETED]: `Table "{{ name }}" deleted`,
290
- [Event.TABLE_EXPORTED]: `Table "{{ name }}" exported`,
291
- [Event.TABLE_IMPORTED]: `Table "{{ name }}" imported`,
292
- [Event.TABLE_DATA_IMPORTED]: `Data imported to table`,
293
-
294
- // ROWS
295
- [Event.ROWS_CREATED]: `Rows created`,
296
- [Event.ROWS_IMPORTED]: `Rows imported`,
297
-
298
- // AUTOMATION
299
- [Event.AUTOMATION_CREATED]: `Automation "{{ name }}" created`,
300
- [Event.AUTOMATION_DELETED]: `Automation "{{ name }}" deleted`,
301
- [Event.AUTOMATION_STEP_CREATED]: `Automation "{{ name }}" step added`,
302
- [Event.AUTOMATION_STEP_DELETED]: `Automation "{{ name }}" step removed`,
303
- [Event.AUTOMATION_TESTED]: undefined,
304
- [Event.AUTOMATIONS_RUN]: undefined,
305
- [Event.AUTOMATION_TRIGGER_UPDATED]: undefined,
306
-
307
- // SCREEN
308
- [Event.SCREEN_CREATED]: `Screen "{{ name }}" created`,
309
- [Event.SCREEN_DELETED]: `Screen "{{ name }}" deleted`,
310
-
311
- // COMPONENT
312
- [Event.COMPONENT_CREATED]: `Component created`,
313
- [Event.COMPONENT_DELETED]: `Component deleted`,
314
-
315
- // ENVIRONMENT VARIABLE
316
- [Event.ENVIRONMENT_VARIABLE_CREATED]: `Environment variable created`,
317
- [Event.ENVIRONMENT_VARIABLE_DELETED]: `Environment variable deleted`,
318
- [Event.ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED]: undefined,
319
-
320
- // PLUGIN
321
- [Event.PLUGIN_IMPORTED]: `Plugin imported`,
322
- [Event.PLUGIN_DELETED]: `Plugin deleted`,
323
- [Event.PLUGIN_INIT]: undefined,
324
-
325
- // ROLE - NOT AUDITED
326
- [Event.ROLE_CREATED]: undefined,
327
- [Event.ROLE_UPDATED]: undefined,
328
- [Event.ROLE_DELETED]: undefined,
329
- [Event.ROLE_ASSIGNED]: undefined,
330
- [Event.ROLE_UNASSIGNED]: undefined,
331
-
332
- // LICENSE - NOT AUDITED
333
- [Event.LICENSE_PLAN_CHANGED]: undefined,
334
- [Event.LICENSE_ACTIVATED]: undefined,
335
- [Event.LICENSE_PAYMENT_FAILED]: undefined,
336
- [Event.LICENSE_PAYMENT_RECOVERED]: undefined,
337
- [Event.LICENSE_CHECKOUT_OPENED]: undefined,
338
- [Event.LICENSE_CHECKOUT_SUCCESS]: undefined,
339
- [Event.LICENSE_PORTAL_OPENED]: undefined,
340
-
341
- // ACCOUNT - NOT AUDITED
342
- [Event.ACCOUNT_CREATED]: undefined,
343
- [Event.ACCOUNT_DELETED]: undefined,
344
- [Event.ACCOUNT_VERIFIED]: undefined,
345
-
346
- // BACKFILL - NOT AUDITED
347
- [Event.APP_BACKFILL_SUCCEEDED]: undefined,
348
- [Event.APP_BACKFILL_FAILED]: undefined,
349
- [Event.TENANT_BACKFILL_SUCCEEDED]: undefined,
350
- [Event.TENANT_BACKFILL_FAILED]: undefined,
351
- [Event.INSTALLATION_BACKFILL_SUCCEEDED]: undefined,
352
- [Event.INSTALLATION_BACKFILL_FAILED]: undefined,
353
-
354
- // LAYOUT - NOT AUDITED
355
- [Event.LAYOUT_CREATED]: undefined,
356
- [Event.LAYOUT_DELETED]: undefined,
357
-
358
- // VIEW - NOT AUDITED
359
- [Event.VIEW_CREATED]: undefined,
360
- [Event.VIEW_UPDATED]: undefined,
361
- [Event.VIEW_DELETED]: undefined,
362
- [Event.VIEW_EXPORTED]: undefined,
363
- [Event.VIEW_FILTER_CREATED]: undefined,
364
- [Event.VIEW_FILTER_UPDATED]: undefined,
365
- [Event.VIEW_FILTER_DELETED]: undefined,
366
- [Event.VIEW_CALCULATION_CREATED]: undefined,
367
- [Event.VIEW_CALCULATION_UPDATED]: undefined,
368
- [Event.VIEW_CALCULATION_DELETED]: undefined,
369
-
370
- // SERVED - NOT AUDITED
371
- [Event.SERVED_BUILDER]: undefined,
372
- [Event.SERVED_APP]: undefined,
373
- [Event.SERVED_APP_PREVIEW]: undefined,
374
-
375
- // ANALYTICS - NOT AUDITED
376
- [Event.ANALYTICS_OPT_OUT]: undefined,
377
- [Event.ANALYTICS_OPT_IN]: undefined,
378
-
379
- // INSTALLATION - NOT AUDITED
380
- [Event.INSTALLATION_VERSION_CHECKED]: undefined,
381
- [Event.INSTALLATION_VERSION_UPGRADED]: undefined,
382
- [Event.INSTALLATION_VERSION_DOWNGRADED]: undefined,
383
- [Event.INSTALLATION_FIRST_STARTUP]: undefined,
384
-
385
- // AUDIT LOG - NOT AUDITED
386
- [Event.AUDIT_LOGS_FILTERED]: undefined,
387
- [Event.AUDIT_LOGS_DOWNLOADED]: undefined,
388
- }
389
-
390
- // properties added at the final stage of the event pipeline
391
- export interface BaseEvent {
392
- version?: string
393
- service?: string
394
- environment?: string
395
- appId?: string
396
- installationId?: string
397
- tenantId?: string
398
- hosting?: Hosting
399
- // any props in the audited section will be removed before passing events
400
- // up out of system (purely for use with auditing)
401
- audited?: {
402
- [key: string]: any
403
- }
404
- }
405
-
406
- export type TableExportFormat = "json" | "csv"
407
-
408
- export type DocUpdateEvent = {
409
- id: string
410
- tenantId: string
411
- appId?: string
412
- }
413
-
414
- export interface EventProcessor {
415
- processEvent(
416
- event: Event,
417
- identity: Identity,
418
- properties: any,
419
- timestamp?: string | number
420
- ): Promise<void>
421
- identify?(identity: Identity, timestamp?: string | number): Promise<void>
422
- identifyGroup?(group: Group, timestamp?: string | number): Promise<void>
423
- shutdown?(): void
424
- }
@@ -1,60 +0,0 @@
1
- import { Hosting } from ".."
2
-
3
- // GROUPS
4
-
5
- export enum GroupType {
6
- TENANT = "tenant",
7
- INSTALLATION = "installation",
8
- }
9
-
10
- export interface Group {
11
- id: string
12
- type: IdentityType
13
- environment: string
14
- hosting: Hosting
15
- }
16
-
17
- export interface TenantGroup extends Group {
18
- // account level information is associated with the tenant group
19
- // as we don't have this at the user level
20
- profession?: string // only available in cloud
21
- companySize?: string // only available in cloud
22
- installationId: string
23
- }
24
-
25
- export interface InstallationGroup extends Group {
26
- version: string
27
- }
28
-
29
- // IDENTITIES
30
-
31
- export enum IdentityType {
32
- USER = "user",
33
- TENANT = "tenant",
34
- INSTALLATION = "installation",
35
- }
36
-
37
- export interface HostInfo {
38
- ipAddress?: string
39
- userAgent?: string
40
- }
41
-
42
- export interface Identity {
43
- id: string
44
- type: IdentityType
45
- hosting: Hosting
46
- environment: string
47
- installationId?: string
48
- tenantId?: string
49
- // usable - no unique format
50
- realTenantId?: string
51
- hostInfo?: HostInfo
52
- }
53
-
54
- export interface UserIdentity extends Identity {
55
- verified: boolean
56
- accountHolder: boolean
57
- providerType?: string
58
- builder?: boolean
59
- admin?: boolean
60
- }
@@ -1,25 +0,0 @@
1
- export * from "./app"
2
- export * from "./auth"
3
- export * from "./automation"
4
- export * from "./email"
5
- export * from "./datasource"
6
- export * from "./event"
7
- export * from "./layout"
8
- export * from "./license"
9
- export * from "./version"
10
- export * from "./query"
11
- export * from "./role"
12
- export * from "./rows"
13
- export * from "./screen"
14
- export * from "./serve"
15
- export * from "./table"
16
- export * from "./user"
17
- export * from "./view"
18
- export * from "./account"
19
- export * from "./backfill"
20
- export * from "./identification"
21
- export * from "./userGroup"
22
- export * from "./plugin"
23
- export * from "./backup"
24
- export * from "./environmentVariable"
25
- export * from "./auditLog"
@@ -1,36 +0,0 @@
1
- import { PlanType, PriceDuration } from "../licensing"
2
-
3
- export interface LicensePlanChangedEvent {
4
- accountId: string
5
- from: PlanType
6
- to: PlanType
7
- // may not be on historical events
8
- fromDuration: PriceDuration | undefined
9
- toDuration: PriceDuration | undefined
10
- fromQuantity: number | undefined
11
- toQuantity: number | undefined
12
- }
13
-
14
- export interface LicenseActivatedEvent {
15
- accountId: string
16
- }
17
-
18
- export interface LicenseCheckoutOpenedEvent {
19
- accountId: string
20
- }
21
-
22
- export interface LicenseCheckoutSuccessEvent {
23
- accountId: string
24
- }
25
-
26
- export interface LicensePortalOpenedEvent {
27
- accountId: string
28
- }
29
-
30
- export interface LicensePaymentFailedEvent {
31
- accountId: string
32
- }
33
-
34
- export interface LicensePaymentRecoveredEvent {
35
- accountId: string
36
- }
@@ -1,26 +0,0 @@
1
- import { BaseEvent } from "./event"
2
- import { PluginSource, PluginType } from "../../"
3
-
4
- export interface PluginInitEvent extends BaseEvent {
5
- type: PluginType
6
- name: string
7
- version: string
8
- description: string
9
- }
10
-
11
- export interface PluginImportedEvent extends BaseEvent {
12
- pluginId: string
13
- type: PluginType
14
- source: PluginSource
15
- name: string
16
- version: string
17
- description: string
18
- }
19
-
20
- export interface PluginDeletedEvent extends BaseEvent {
21
- pluginId: string
22
- type: PluginType
23
- name: string
24
- version: string
25
- description: string
26
- }
@@ -1,40 +0,0 @@
1
- import { BaseEvent } from "./event"
2
-
3
- export interface QueryCreatedEvent extends BaseEvent {
4
- queryId: string
5
- datasourceId: string
6
- source: string
7
- queryVerb: string
8
- }
9
-
10
- export interface QueryUpdatedEvent extends BaseEvent {
11
- queryId: string
12
- datasourceId: string
13
- source: string
14
- queryVerb: string
15
- }
16
-
17
- export interface QueryDeletedEvent extends BaseEvent {
18
- queryId: string
19
- datasourceId: string
20
- source: string
21
- queryVerb: string
22
- }
23
-
24
- export interface QueryImportedEvent extends BaseEvent {
25
- datasourceId: string
26
- source: string
27
- count: number
28
- importSource: string
29
- }
30
-
31
- export interface QueryPreviewedEvent extends BaseEvent {
32
- queryId?: string
33
- datasourceId: string
34
- source: string
35
- queryVerb: string
36
- }
37
-
38
- export interface QueriesRunEvent extends BaseEvent {
39
- count: number
40
- }
@@ -1,29 +0,0 @@
1
- import { BaseEvent } from "./event"
2
-
3
- export interface RoleCreatedEvent extends BaseEvent {
4
- roleId: string
5
- permissionId: string
6
- inherits?: string
7
- }
8
-
9
- export interface RoleUpdatedEvent extends BaseEvent {
10
- roleId: string
11
- permissionId: string
12
- inherits?: string
13
- }
14
-
15
- export interface RoleDeletedEvent extends BaseEvent {
16
- roleId: string
17
- permissionId: string
18
- inherits?: string
19
- }
20
-
21
- export interface RoleAssignedEvent extends BaseEvent {
22
- userId: string
23
- roleId: string
24
- }
25
-
26
- export interface RoleUnassignedEvent extends BaseEvent {
27
- userId: string
28
- roleId: string
29
- }
@@ -1,19 +0,0 @@
1
- import { BaseEvent } from "./event"
2
-
3
- export interface ScreenCreatedEvent extends BaseEvent {
4
- screenId: string
5
- layoutId?: string
6
- roleId: string
7
- audited: {
8
- name: string
9
- }
10
- }
11
-
12
- export interface ScreenDeletedEvent extends BaseEvent {
13
- screenId: string
14
- layoutId?: string
15
- roleId: string
16
- audited: {
17
- name: string
18
- }
19
- }
@@ -1,37 +0,0 @@
1
- import { BaseEvent, TableExportFormat } from "./event"
2
-
3
- export interface TableCreatedEvent extends BaseEvent {
4
- tableId: string
5
- audited: {
6
- name: string
7
- }
8
- }
9
-
10
- export interface TableUpdatedEvent extends BaseEvent {
11
- tableId: string
12
- audited: {
13
- name: string
14
- }
15
- }
16
-
17
- export interface TableDeletedEvent extends BaseEvent {
18
- tableId: string
19
- audited: {
20
- name: string
21
- }
22
- }
23
-
24
- export interface TableExportedEvent extends BaseEvent {
25
- tableId: string
26
- format: TableExportFormat
27
- audited: {
28
- name: string
29
- }
30
- }
31
-
32
- export interface TableImportedEvent extends BaseEvent {
33
- tableId: string
34
- audited: {
35
- name: string
36
- }
37
- }