@friggframework/core 2.0.0--canary.405.1f6792c.0 → 2.0.0--canary.396.6862738.0

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 (59) hide show
  1. package/credential/credential-repository.js +9 -0
  2. package/credential/use-cases/get-credential-for-user.js +21 -0
  3. package/encrypt/encrypt.js +27 -4
  4. package/handlers/app-definition-loader.js +38 -0
  5. package/handlers/app-handler-helpers.js +0 -3
  6. package/handlers/backend-utils.js +29 -34
  7. package/handlers/routers/auth.js +14 -11
  8. package/handlers/routers/integration-defined-routers.js +8 -5
  9. package/handlers/routers/user.js +25 -5
  10. package/handlers/workers/integration-defined-workers.js +6 -3
  11. package/index.js +0 -11
  12. package/integrations/index.js +0 -5
  13. package/integrations/integration-base.js +10 -7
  14. package/integrations/integration-repository.js +44 -0
  15. package/integrations/integration-router.js +230 -132
  16. package/integrations/integration.js +233 -0
  17. package/integrations/options.js +1 -1
  18. package/integrations/use-cases/create-integration.js +58 -0
  19. package/integrations/use-cases/delete-integration-for-user.js +53 -0
  20. package/integrations/use-cases/get-integration-for-user.js +63 -0
  21. package/integrations/use-cases/get-integration-instance.js +73 -0
  22. package/integrations/use-cases/get-integrations-for-user.js +64 -0
  23. package/integrations/use-cases/index.js +11 -0
  24. package/integrations/use-cases/update-integration.js +81 -0
  25. package/integrations/utils/map-integration-dto.js +37 -0
  26. package/module-plugin/index.js +0 -4
  27. package/module-plugin/module-factory.js +13 -32
  28. package/module-plugin/module-repository.js +70 -0
  29. package/module-plugin/module-service.js +50 -0
  30. package/module-plugin/{auther.js → module.js} +109 -173
  31. package/module-plugin/test/mock-api/api.js +8 -3
  32. package/module-plugin/test/mock-api/definition.js +12 -8
  33. package/module-plugin/use-cases/get-entities-for-user.js +32 -0
  34. package/module-plugin/utils/map-module-dto.js +18 -0
  35. package/package.json +5 -5
  36. package/types/integrations/index.d.ts +2 -6
  37. package/types/module-plugin/index.d.ts +4 -21
  38. package/user/tests/doubles/test-user-repository.js +72 -0
  39. package/user/tests/use-cases/create-individual-user.test.js +24 -0
  40. package/user/tests/use-cases/create-organization-user.test.js +28 -0
  41. package/user/tests/use-cases/create-token-for-user-id.test.js +19 -0
  42. package/user/tests/use-cases/get-user-from-bearer-token.test.js +64 -0
  43. package/user/tests/use-cases/login-user.test.js +140 -0
  44. package/user/use-cases/create-individual-user.js +61 -0
  45. package/user/use-cases/create-organization-user.js +47 -0
  46. package/user/use-cases/create-token-for-user-id.js +30 -0
  47. package/user/use-cases/get-user-from-bearer-token.js +77 -0
  48. package/user/use-cases/login-user.js +122 -0
  49. package/user/user-repository.js +62 -0
  50. package/user/user.js +77 -0
  51. package/handlers/routers/HEALTHCHECK.md +0 -240
  52. package/handlers/routers/health.js +0 -459
  53. package/handlers/routers/health.test.js +0 -203
  54. package/handlers/routers/middleware/loadUser.js +0 -15
  55. package/handlers/routers/middleware/requireLoggedInUser.js +0 -12
  56. package/integrations/create-frigg-backend.js +0 -31
  57. package/integrations/integration-factory.js +0 -251
  58. package/integrations/integration-user.js +0 -144
  59. package/module-plugin/entity-manager.js +0 -70
@@ -1,31 +0,0 @@
1
- const {IntegrationFactory, IntegrationHelper} = require('./integration-factory');
2
- const User = require('./integration-user');
3
-
4
- function createFriggBackend(appDefinition) {
5
- const {integrations = [], user=null} = appDefinition
6
- const integrationFactory = new IntegrationFactory(integrations);
7
- if (user) {
8
- if (user.usePassword) {
9
- User.usePassword = true;
10
- }
11
- if (user.primary === 'organization') {
12
- User.primary = User.OrganizationUser
13
- }
14
- if (user.individualUserRequired !== undefined) {
15
- User.individualUserRequired = user.individualUserRequired
16
- }
17
- if (user.organizationUserRequired !== undefined) {
18
- User.organizationUserRequired = user.organizationUserRequired
19
- }
20
-
21
- }
22
- const backend = {
23
- integrationFactory,
24
- moduleFactory: integrationFactory.moduleFactory,
25
- IntegrationHelper,
26
- User: User
27
- }
28
- return backend
29
- }
30
-
31
- module.exports = { createFriggBackend }
@@ -1,251 +0,0 @@
1
- const { ModuleFactory, Credential, Entity } = require('../module-plugin');
2
- const { IntegrationModel } = require('./integration-model');
3
- const _ = require('lodash');
4
-
5
- class IntegrationFactory {
6
- constructor(integrationClasses = []) {
7
- this.integrationClasses = integrationClasses;
8
- this.moduleFactory = new ModuleFactory(...this.getModules());
9
- this.integrationTypes = this.integrationClasses.map(
10
- (IntegrationClass) => IntegrationClass.getName()
11
- );
12
- this.getIntegrationDefinitions = this.integrationClasses.map(
13
- (IntegrationClass) => IntegrationClass.Definition
14
- );
15
- }
16
-
17
- async getIntegrationOptions() {
18
- const options = this.integrationClasses.map(
19
- (IntegrationClass) => IntegrationClass
20
- );
21
- return {
22
- entities: {
23
- options: options.map((IntegrationClass) =>
24
- IntegrationClass.getOptionDetails()
25
- ),
26
- authorized: [],
27
- },
28
- integrations: [],
29
- };
30
- }
31
-
32
- getModules() {
33
- return [
34
- ...new Set(
35
- this.integrationClasses
36
- .map((integration) =>
37
- Object.values(integration.Definition.modules).map(
38
- (module) => module.definition
39
- )
40
- )
41
- .flat()
42
- ),
43
- ];
44
- }
45
-
46
- getIntegrationClassByType(type) {
47
- const integrationClassIndex = this.integrationTypes.indexOf(type);
48
- return this.integrationClasses[integrationClassIndex];
49
- }
50
- getModuleTypesAndKeys(integrationClass) {
51
- const moduleTypesAndKeys = {};
52
- const moduleTypeCount = {};
53
-
54
- if (integrationClass && integrationClass.Definition.modules) {
55
- for (const [key, moduleClass] of Object.entries(
56
- integrationClass.Definition.modules
57
- )) {
58
- if (
59
- moduleClass &&
60
- typeof moduleClass.definition.getName === 'function'
61
- ) {
62
- const moduleType = moduleClass.definition.getName();
63
-
64
- // Check if this module type has already been seen
65
- if (moduleType in moduleTypesAndKeys) {
66
- throw new Error(
67
- `Duplicate module type "${moduleType}" found in integration class definition.`
68
- );
69
- }
70
-
71
- // Well how baout now
72
-
73
- moduleTypesAndKeys[moduleType] = key;
74
- moduleTypeCount[moduleType] =
75
- (moduleTypeCount[moduleType] || 0) + 1;
76
- }
77
- }
78
- }
79
-
80
- // Check for any module types with count > 1
81
- for (const [moduleType, count] of Object.entries(moduleTypeCount)) {
82
- if (count > 1) {
83
- throw new Error(
84
- `Multiple instances of module type "${moduleType}" found in integration class definition.`
85
- );
86
- }
87
- }
88
-
89
- return moduleTypesAndKeys;
90
- }
91
-
92
- async getInstanceFromIntegrationId(params) {
93
- const integrationRecord = await IntegrationHelper.getIntegrationById(
94
- params.integrationId
95
- );
96
- let { userId } = params;
97
- if (!integrationRecord) {
98
- throw new Error(
99
- `No integration found by the ID of ${params.integrationId}`
100
- );
101
- }
102
-
103
- if (!userId) {
104
- userId = integrationRecord.user._id.toString();
105
- } else if (userId.toString() !== integrationRecord.user.toString()) {
106
- throw new Error(
107
- `Integration ${
108
- params.integrationId
109
- } does not belong to User ${userId}, ${integrationRecord.user.toString()}`
110
- );
111
- }
112
-
113
- const integrationClass = this.getIntegrationClassByType(
114
- integrationRecord.config.type
115
- );
116
-
117
- const instance = new integrationClass({
118
- userId,
119
- integrationId: params.integrationId,
120
- });
121
-
122
- if (
123
- integrationRecord.entityReference &&
124
- Object.keys(integrationRecord.entityReference) > 0
125
- ) {
126
- // Use the specified entityReference to find the modules and load them according to their key
127
- // entityReference will be a map of entityIds with their corresponding desired key
128
- for (const [entityId, key] of Object.entries(
129
- integrationRecord.entityReference
130
- )) {
131
- const moduleInstance =
132
- await this.moduleFactory.getModuleInstanceFromEntityId(
133
- entityId,
134
- integrationRecord.user
135
- );
136
- instance[key] = moduleInstance;
137
- }
138
- } else {
139
- // for each entity, get the moduleinstance and load them according to their keys
140
- // If it's the first entity, load the moduleinstance into primary as well
141
- // If it's the second entity, load the moduleinstance into target as well
142
- const moduleTypesAndKeys =
143
- this.getModuleTypesAndKeys(integrationClass);
144
- for (let i = 0; i < integrationRecord.entities.length; i++) {
145
- const entityId = integrationRecord.entities[i];
146
- const moduleInstance =
147
- await this.moduleFactory.getModuleInstanceFromEntityId(
148
- entityId,
149
- integrationRecord.user
150
- );
151
- const moduleType = moduleInstance.getName();
152
- const key = moduleTypesAndKeys[moduleType];
153
- instance[key] = moduleInstance;
154
- if (i === 0) {
155
- instance.primary = moduleInstance;
156
- } else if (i === 1) {
157
- instance.target = moduleInstance;
158
- }
159
- }
160
- }
161
- instance.record = integrationRecord;
162
-
163
- try {
164
- const additionalUserActions =
165
- await instance.loadDynamicUserActions();
166
- instance.events = { ...instance.events, ...additionalUserActions };
167
- } catch (e) {
168
- instance.record.status = 'ERROR';
169
- instance.record.messages.errors.push(e);
170
- await instance.record.save();
171
- }
172
- // Register all of the event handlers
173
-
174
- await instance.registerEventHandlers();
175
- return instance;
176
- }
177
-
178
- async createIntegration(entities, userId, config) {
179
- const integrationRecord = await IntegrationModel.create({
180
- entities: entities,
181
- user: userId,
182
- config,
183
- version: '0.0.0',
184
- });
185
- return await this.getInstanceFromIntegrationId({
186
- integrationId: integrationRecord.id,
187
- userId,
188
- });
189
- }
190
- }
191
-
192
- const IntegrationHelper = {
193
- getFormattedIntegration: async function (integrationRecord) {
194
- const integrationObj = {
195
- id: integrationRecord.id,
196
- status: integrationRecord.status,
197
- config: integrationRecord.config,
198
- entities: [],
199
- version: integrationRecord.version,
200
- messages: integrationRecord.messages,
201
- };
202
- for (const entityId of integrationRecord.entities) {
203
- // Only return non-internal fields. Leverages "select" and "options" to non-excepted fields and a pure object.
204
- const entity = await Entity.findById(
205
- entityId,
206
- '-createdAt -updatedAt -user -credentials -credential -_id -__t -__v',
207
- { lean: true }
208
- );
209
- integrationObj.entities.push({
210
- id: entityId,
211
- ...entity,
212
- });
213
- }
214
- return integrationObj;
215
- },
216
-
217
- getIntegrationsForUserId: async function (userId) {
218
- const integrationList = await IntegrationModel.find({ user: userId });
219
- return await Promise.all(
220
- integrationList.map(
221
- async (integrationRecord) =>
222
- await IntegrationHelper.getFormattedIntegration(
223
- integrationRecord
224
- )
225
- )
226
- );
227
- },
228
-
229
- deleteIntegrationForUserById: async function (userId, integrationId) {
230
- const integrationList = await IntegrationModel.find({
231
- user: userId,
232
- _id: integrationId,
233
- });
234
- if (integrationList.length !== 1) {
235
- throw new Error(
236
- `Integration with id of ${integrationId} does not exist for this user`
237
- );
238
- }
239
- await IntegrationModel.deleteOne({ _id: integrationId });
240
- },
241
-
242
- getIntegrationById: async function (id) {
243
- return IntegrationModel.findById(id).populate('entities');
244
- },
245
-
246
- listCredentials: async function (options) {
247
- return Credential.find(options);
248
- },
249
- };
250
-
251
- module.exports = { IntegrationFactory, IntegrationHelper };
@@ -1,144 +0,0 @@
1
- const bcrypt = require('bcryptjs');
2
- const crypto = require('crypto');
3
- const { get } = require('../assertions');
4
- const { Token } = require('../database/models/Token');
5
- const { IndividualUser } = require('../database/models/IndividualUser');
6
- const { OrganizationUser } = require('../database/models/OrganizationUser');
7
- const Boom = require('@hapi/boom');
8
-
9
- class User {
10
- static IndividualUser = IndividualUser;
11
- static OrganizationUser = OrganizationUser;
12
- static Token = Token;
13
- static usePassword = false
14
- static primary = User.IndividualUser;
15
- static individualUserRequired = true;
16
- static organizationUserRequired = false;
17
-
18
- constructor() {
19
- this.user = null;
20
- this.individualUser = null;
21
- this.organizationUser = null;
22
- }
23
-
24
- getPrimaryUser() {
25
- if (User.primary === User.OrganizationUser) {
26
- return this.organizationUser;
27
- }
28
- return this.individualUser;
29
- }
30
-
31
- getUserId() {
32
- return this.getPrimaryUser()?.id;
33
- }
34
-
35
- isLoggedIn() {
36
- return Boolean(this.getUserId());
37
- }
38
-
39
- async createUserToken(minutes) {
40
- const rawToken = crypto.randomBytes(20).toString('hex');
41
- const createdToken = await User.Token.createTokenWithExpire(this.getUserId(), rawToken, 120);
42
- const tokenBuf = User.Token.createBase64BufferToken(createdToken, rawToken);
43
- return tokenBuf;
44
- }
45
-
46
- static async newUser(params={}) {
47
- const user = new User();
48
- const token = get(params, 'token', null);
49
- if (token) {
50
- const jsonToken = this.Token.getJSONTokenFromBase64BufferToken(token);
51
- const sessionToken = await this.Token.validateAndGetTokenFromJSONToken(jsonToken);
52
- if (this.primary === User.OrganizationUser) {
53
- user.organizationUser = await this.OrganizationUser.findById(sessionToken.user);
54
- } else {
55
- user.individualUser = await this.IndividualUser.findById(sessionToken.user);
56
- }
57
- }
58
- return user;
59
- }
60
-
61
- static async createIndividualUser(params) {
62
- const user = await this.newUser(params);
63
- let hashword;
64
- if (this.usePassword) {
65
- hashword = get(params, 'password');
66
- }
67
-
68
- const email = get(params, 'email', null);
69
- const username = get(params, 'username', null);
70
- if (!email && !username) {
71
- throw Boom.badRequest('email or username is required');
72
- }
73
-
74
- const appUserId = get(params, 'appUserId', null);
75
- const organizationUserId = get(params, 'organizationUserId', null);
76
-
77
- user.individualUser = await this.IndividualUser.create({
78
- email,
79
- username,
80
- hashword,
81
- appUserId,
82
- organizationUser: organizationUserId,
83
- });
84
- return user;
85
- }
86
-
87
- static async createOrganizationUser(params) {
88
- const user = await this.newUser(params);
89
- const name = get(params, 'name');
90
- const appOrgId = get(params, 'appOrgId');
91
- user.organizationUser = await this.OrganizationUser.create({
92
- name,
93
- appOrgId,
94
- });
95
- return user;
96
- }
97
-
98
- static async loginUser(params) {
99
- const user = await this.newUser(params);
100
-
101
- if (this.usePassword){
102
- const username = get(params, 'username');
103
- const password = get(params, 'password');
104
-
105
- const individualUser = await this.IndividualUser.findOne({username});
106
-
107
- if (!individualUser) {
108
- throw Boom.unauthorized('incorrect username or password');
109
- }
110
-
111
- const isValid = await bcrypt.compareSync(password, individualUser.hashword);
112
- if (!isValid) {
113
- throw Boom.unauthorized('incorrect username or password');
114
- }
115
- user.individualUser = individualUser;
116
- }
117
- else {
118
- const appUserId = get(params, 'appUserId', null);
119
- user.individualUser = await this.IndividualUser.getUserByAppUserId(
120
- appUserId
121
- );
122
- }
123
-
124
- const appOrgId = get(params, 'appOrgId', null);
125
- user.organizationUser = await this.OrganizationUser.getUserByAppOrgId(
126
- appOrgId
127
- );
128
-
129
- if (this.individualUserRequired) {
130
- if (!user.individualUser) {
131
- throw Boom.unauthorized('user not found');
132
- }
133
- }
134
-
135
- if (this.organizationUserRequired) {
136
- if (!user.organizationUser) {
137
- throw Boom.unauthorized(`org user ${appOrgId} not found`);
138
- }
139
- }
140
- return user;
141
- }
142
- }
143
-
144
- module.exports = User;
@@ -1,70 +0,0 @@
1
- const { loadInstalledModules, Delegate } = require('../core');
2
-
3
- const { Entity } = require('./entity');
4
- const { ModuleManager } = require('./manager');
5
-
6
- class EntityManager {
7
- static primaryEntityClass = null; //primaryEntity;
8
-
9
- static entityManagerClasses = loadInstalledModules().map(
10
- (m) => m.EntityManager
11
- );
12
-
13
- static entityTypes = EntityManager.entityManagerClasses.map(
14
- (ManagerClass) => ManagerClass.getName()
15
- );
16
-
17
- static async getEntitiesForUser(userId) {
18
- const results = [];
19
- for (const Manager of this.entityManagerClasses) {
20
- results.push(...(await Manager.getEntitiesForUserId(userId)));
21
- }
22
- return results;
23
- }
24
-
25
- static checkIsValidType(entityType) {
26
- const indexOfEntity = EntityManager.entityTypes.indexOf(entityType);
27
- return indexOfEntity >= 0;
28
- }
29
-
30
- static getEntityManagerClass(entityType = '') {
31
- const normalizedType = entityType.toLowerCase();
32
-
33
- const indexOfEntityType =
34
- EntityManager.entityTypes.indexOf(normalizedType);
35
- if (!EntityManager.checkIsValidType(normalizedType)) {
36
- throw new Error(
37
- `Error: Invalid entity type of ${normalizedType}, options are ${EntityManager.entityTypes.join(
38
- ', '
39
- )}`
40
- );
41
- }
42
-
43
- const managerClass =
44
- EntityManager.entityManagerClasses[indexOfEntityType];
45
-
46
- if (!(managerClass.prototype instanceof ModuleManager)) {
47
- throw new Error('The Entity is not an instance of ModuleManager');
48
- }
49
-
50
- return managerClass;
51
- }
52
-
53
- static async getEntityManagerInstanceFromEntityId(entityId, userId) {
54
- const entityMO = new Entity();
55
- const entity = await entityMO.get(entityId);
56
- let entityManagerClass;
57
- for (const Manager of this.entityManagerClasses) {
58
- if (entity instanceof Manager.Entity.Model) {
59
- entityManagerClass = Manager;
60
- }
61
- }
62
- const instance = await entityManagerClass.getInstance({
63
- userId,
64
- entityId,
65
- });
66
- return instance;
67
- }
68
- }
69
-
70
- module.exports = { EntityManager };