@friggframework/core 2.0.0--canary.704.79d9a63.0 → 2.0.0--canary.686.e94de4d.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.
- package/CLAUDE.md +28 -40
- package/README.md +105 -0
- package/application/commands/entity-commands.js +60 -18
- package/application/commands/integration-commands.js +20 -73
- package/application/commands/scheduler-commands.js +11 -7
- package/application/commands/user-commands.js +17 -5
- package/application/index.js +6 -2
- package/core/Worker.js +31 -7
- package/core/create-handler.js +9 -0
- package/credential/repositories/credential-repository-documentdb.js +34 -0
- package/credential/repositories/credential-repository-interface.js +15 -0
- package/credential/repositories/credential-repository-mongo.js +23 -0
- package/credential/repositories/credential-repository-postgres.js +28 -0
- package/credential/use-cases/credential-operations-for-user.js +202 -0
- package/credential/use-cases/reauthorize-credential-for-user.js +73 -0
- package/database/config.js +48 -24
- package/database/documentdb-encryption-service.js +9 -22
- package/database/documentdb-utils.js +2 -0
- package/database/encryption/README.md +76 -14
- package/database/encryption/documentdb-encryption-service.md +78 -1
- package/database/encryption/encryption-config.js +219 -0
- package/database/encryption/encryption-schema-registry.js +93 -12
- package/database/encryption/integration-mapping-encryption.js +1 -1
- package/database/organization-where.js +18 -0
- package/database/prisma.js +15 -38
- package/database/unique-violation.js +25 -0
- package/database/use-cases/check-encryption-health-use-case.js +43 -52
- package/errors/index.js +0 -4
- package/extensions/bootstrap-runner.js +43 -0
- package/extensions/extension-loader.js +187 -0
- package/extensions/index.js +41 -0
- package/extensions/initialize-app.js +123 -0
- package/extensions/route-mounter.js +103 -0
- package/extensions/schema-composer.js +188 -0
- package/generated/prisma-mongodb/edge.js +43 -4
- package/generated/prisma-mongodb/index-browser.js +40 -1
- package/generated/prisma-mongodb/index.d.ts +4761 -133
- package/generated/prisma-mongodb/index.js +43 -4
- package/generated/prisma-mongodb/package.json +1 -1
- package/generated/prisma-mongodb/schema.prisma +92 -0
- package/generated/prisma-mongodb/wasm.js +43 -4
- package/generated/prisma-postgresql/edge.js +43 -4
- package/generated/prisma-postgresql/index-browser.js +40 -1
- package/generated/prisma-postgresql/index.d.ts +4961 -28
- package/generated/prisma-postgresql/index.js +43 -4
- package/generated/prisma-postgresql/package.json +1 -1
- package/generated/prisma-postgresql/schema.prisma +87 -0
- package/generated/prisma-postgresql/wasm.js +43 -4
- package/handlers/WEBHOOKS.md +0 -29
- package/handlers/app-definition-loader.js +121 -19
- package/handlers/app-handler-helpers.js +25 -3
- package/handlers/backend-utils.js +31 -25
- package/handlers/middleware/admin-auth.js +14 -1
- package/handlers/routers/auth.js +46 -10
- package/handlers/routers/health.js +13 -4
- package/handlers/routers/integration-defined-routers.js +144 -92
- package/handlers/routers/integration-webhook-routers.js +102 -64
- package/handlers/workers/integration-defined-workers.js +5 -2
- package/index.js +65 -3
- package/infrastructure/scheduler/index.js +19 -6
- package/infrastructure/scheduler/netlify-scheduler-adapter.js +216 -0
- package/infrastructure/scheduler/scheduled-job-repository.js +118 -0
- package/infrastructure/scheduler/scheduler-service-factory.js +55 -7
- package/integrations/index.js +1 -0
- package/integrations/integration-base.js +0 -29
- package/integrations/integration-router.js +131 -96
- package/integrations/repositories/integration-mapping-repository-documentdb.js +0 -50
- package/integrations/repositories/integration-mapping-repository-interface.js +0 -15
- package/integrations/repositories/integration-mapping-repository-mongo.js +0 -29
- package/integrations/repositories/integration-mapping-repository-postgres.js +0 -30
- package/integrations/repositories/integration-mapping-repository.js +0 -29
- package/integrations/repositories/integration-not-found.js +14 -0
- package/integrations/repositories/integration-repository-documentdb.js +35 -35
- package/integrations/repositories/integration-repository-interface.js +17 -31
- package/integrations/repositories/integration-repository-mongo.js +60 -129
- package/integrations/repositories/integration-repository-postgres.js +62 -134
- package/integrations/repositories/process-repository-mongo.js +1 -1
- package/integrations/schedule-config.js +80 -0
- package/integrations/tests/doubles/test-integration-repository.js +12 -1
- package/integrations/use-cases/create-integration.js +72 -75
- package/integrations/use-cases/dispatch-ongoing-syncs.js +100 -0
- package/integrations/use-cases/get-integrations-for-user.js +80 -40
- package/integrations/use-cases/index.js +7 -1
- package/integrations/use-cases/integration-operations-for-user.js +256 -0
- package/integrations/use-cases/resolve-integration-ownership.js +177 -0
- package/integrations/utils/map-integration-dto.js +43 -14
- package/management-api/create-management-api-router.js +49 -0
- package/management-api/error-response.js +116 -0
- package/management-api/management-api-config.js +151 -0
- package/management-api/meta-router.js +76 -0
- package/management-api/openapi/build-openapi.js +144 -0
- package/management-api/openapi/components.js +408 -0
- package/management-api/openapi/v1-operations.js +83 -0
- package/management-api/openapi/v2-operations.js +264 -0
- package/management-api/route-registry.js +411 -0
- package/management-api/test-support/http-client.js +39 -0
- package/management-api/use-cases/get-management-api-meta.js +57 -0
- package/management-api/v1-deprecation.js +120 -0
- package/management-api/v2/create-v2-router.js +85 -0
- package/management-api/v2/dependencies.js +281 -0
- package/management-api/v2/dto.js +143 -0
- package/management-api/v2/handlers/authorization.js +94 -0
- package/management-api/v2/handlers/credentials.js +33 -0
- package/management-api/v2/handlers/entities.js +77 -0
- package/management-api/v2/handlers/integrations.js +128 -0
- package/management-api/v2/handlers/proxy.js +34 -0
- package/management-api/v2/request.js +85 -0
- package/management-api/v2/test-support/fake-dependencies.js +103 -0
- package/modules/domain/authorization-session.js +144 -0
- package/modules/entity-scope.js +15 -0
- package/modules/entity-type-registry.js +311 -0
- package/modules/index.js +14 -0
- package/modules/module-factory.js +12 -0
- package/modules/module.js +53 -2
- package/modules/proxy/proxy-errors.js +20 -0
- package/modules/proxy/proxy-path.js +179 -0
- package/modules/proxy/proxy-policy.js +248 -0
- package/modules/repositories/authorization-session-repository-documentdb.js +112 -0
- package/modules/repositories/authorization-session-repository-factory.js +31 -0
- package/modules/repositories/authorization-session-repository-interface.js +47 -0
- package/modules/repositories/authorization-session-repository-prisma.js +87 -0
- package/modules/repositories/entity-not-found.js +18 -0
- package/modules/repositories/module-repository-documentdb.js +51 -6
- package/modules/repositories/module-repository-interface.js +19 -2
- package/modules/repositories/module-repository-mongo.js +67 -74
- package/modules/repositories/module-repository-postgres.js +66 -74
- package/modules/repositories/module-repository.js +2 -1
- package/modules/requester/proxy-request.js +244 -0
- package/modules/requester/requester.js +27 -2
- package/modules/scope-config.js +192 -0
- package/modules/scope-policy.js +112 -0
- package/modules/scope-resolution.js +288 -0
- package/modules/scope-visibility.js +247 -0
- package/modules/tests/doubles/in-memory-authorization-session-repository.js +45 -0
- package/modules/tests/doubles/ownership-matching.js +18 -0
- package/modules/use-cases/authorize-entity-for-user.js +61 -0
- package/modules/use-cases/create-entity-from-credential.js +113 -0
- package/modules/use-cases/entity-operations-for-user.js +162 -0
- package/modules/use-cases/entity-types.js +139 -0
- package/modules/use-cases/execute-entity-proxy-request.js +286 -0
- package/modules/use-cases/get-authorization-requirements.js +100 -0
- package/modules/use-cases/get-entities-for-user.js +26 -13
- package/modules/use-cases/get-entity-module-for-user.js +113 -0
- package/modules/use-cases/get-entity-options-by-id.js +10 -4
- package/modules/use-cases/get-entity-options-by-type.js +1 -1
- package/modules/use-cases/get-module-instance-from-type.js +1 -1
- package/modules/use-cases/get-module.js +10 -4
- package/modules/use-cases/manage-access.js +21 -0
- package/modules/use-cases/multi-step-authorization.js +329 -0
- package/modules/use-cases/process-authorization-callback.js +53 -19
- package/modules/use-cases/refresh-entity-options.js +10 -4
- package/modules/use-cases/test-module-auth.js +10 -4
- package/modules/utils/map-module-dto.js +3 -5
- package/package.json +6 -5
- package/prisma-mongodb/schema.prisma +92 -0
- package/prisma-postgresql/migrations/20261003000000_add_authorization_session/migration.sql +28 -0
- package/prisma-postgresql/migrations/20261015000000_add_organization_membership/migration.sql +26 -0
- package/prisma-postgresql/migrations/20261016000000_add_entity_integration_organization/migration.sql +25 -0
- package/prisma-postgresql/migrations/20261017000000_add_scheduled_job/migration.sql +28 -0
- package/prisma-postgresql/schema.prisma +87 -0
- package/providers/index.js +23 -0
- package/providers/resolve-provider.js +93 -0
- package/providers/runtime-detection.js +124 -0
- package/queues/index.js +25 -0
- package/queues/providers/index.js +11 -0
- package/queues/providers/netlify-background-provider.js +150 -0
- package/queues/providers/qstash-queue-provider.js +219 -0
- package/queues/providers/sqs-queue-provider.js +70 -0
- package/queues/queue-client-interface.js +55 -0
- package/queues/queue-message-auth.js +193 -0
- package/queues/queue-provider-factory.js +101 -0
- package/queues/queue-provider.js +65 -0
- package/queues/sqs-queue-client.js +81 -0
- package/types/index.d.ts +2 -0
- package/types/modules/index.d.ts +197 -0
- package/types/user/index.d.ts +134 -0
- package/user/adopter-jwt-config.js +177 -0
- package/user/adopter-jwt-errors.js +59 -0
- package/user/adopter-token-verifier.js +122 -0
- package/user/app-user-helpers.js +97 -0
- package/user/create-user-authentication.js +64 -0
- package/user/membership.js +51 -0
- package/user/repositories/organization-membership-record.js +19 -0
- package/user/repositories/organization-membership-repository-documentdb.js +106 -0
- package/user/repositories/organization-membership-repository-factory.js +42 -0
- package/user/repositories/organization-membership-repository-interface.js +57 -0
- package/user/repositories/organization-membership-repository-mongo.js +13 -0
- package/user/repositories/organization-membership-repository-postgres.js +29 -0
- package/user/repositories/organization-membership-repository-prisma.js +81 -0
- package/user/repositories/user-repository-documentdb.js +27 -2
- package/user/repositories/user-repository-interface.js +18 -0
- package/user/repositories/user-repository-mongo.js +24 -0
- package/user/repositories/user-repository-postgres.js +18 -0
- package/user/tests/doubles/adopter-jwt-fixtures.js +220 -0
- package/user/tests/doubles/test-user-repository.js +1 -1
- package/user/use-cases/authenticate-user.js +7 -1
- package/user/use-cases/ensure-organization-membership.js +92 -0
- package/user/use-cases/find-individual-users-by-organization.js +54 -0
- package/user/use-cases/get-user-from-adopter-jwt.js +95 -124
- package/user/use-cases/get-user-from-bearer-token.js +2 -7
- package/user/use-cases/get-user-from-x-frigg-headers.js +83 -80
- package/user/user.js +64 -1
- package/errors/mapping-already-exists-error.js +0 -14
- package/integrations/use-cases/add-entities-to-integration.js +0 -92
- package/integrations/use-cases/remove-entities-from-integration.js +0 -70
- package/integrations/utils/assert-entity-ids-input.js +0 -42
- package/modules/utils/to-credential-id.js +0 -14
package/database/prisma.js
CHANGED
|
@@ -4,6 +4,7 @@ const {
|
|
|
4
4
|
const { loadCustomEncryptionSchema } = require('./encryption/encryption-schema-registry');
|
|
5
5
|
const { logger } = require('./encryption/logger');
|
|
6
6
|
const { Cryptor } = require('../encrypt/Cryptor');
|
|
7
|
+
const { getEncryptionConfig } = require('./encryption/encryption-config');
|
|
7
8
|
const config = require('./config');
|
|
8
9
|
|
|
9
10
|
/**
|
|
@@ -32,33 +33,6 @@ function ensureMongoDbUrl() {
|
|
|
32
33
|
);
|
|
33
34
|
}
|
|
34
35
|
|
|
35
|
-
function getEncryptionConfig() {
|
|
36
|
-
const STAGE = process.env.STAGE || process.env.NODE_ENV || 'development';
|
|
37
|
-
const shouldBypassEncryption = ['dev', 'test', 'local'].includes(STAGE);
|
|
38
|
-
|
|
39
|
-
if (shouldBypassEncryption) {
|
|
40
|
-
return { enabled: false };
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
const hasKMS =
|
|
44
|
-
process.env.KMS_KEY_ARN && process.env.KMS_KEY_ARN.trim() !== '';
|
|
45
|
-
const hasAES =
|
|
46
|
-
process.env.AES_KEY_ID && process.env.AES_KEY_ID.trim() !== '';
|
|
47
|
-
|
|
48
|
-
if (!hasKMS && !hasAES) {
|
|
49
|
-
logger.warn(
|
|
50
|
-
'No encryption keys configured (KMS_KEY_ARN or AES_KEY_ID). ' +
|
|
51
|
-
'Field-level encryption disabled. Set STAGE=production and configure keys to enable.'
|
|
52
|
-
);
|
|
53
|
-
return { enabled: false };
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
return {
|
|
57
|
-
enabled: true,
|
|
58
|
-
method: hasKMS ? 'kms' : 'aes',
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
|
|
62
36
|
const prismaClientSingleton = () => {
|
|
63
37
|
let PrismaClient;
|
|
64
38
|
|
|
@@ -67,13 +41,15 @@ const prismaClientSingleton = () => {
|
|
|
67
41
|
const paths = [
|
|
68
42
|
// Lambda layer location (when using Prisma Lambda layer)
|
|
69
43
|
`/opt/nodejs/node_modules/generated/prisma-${dbType}`,
|
|
44
|
+
// __dirname-based absolute path (Netlify functions and bundlers)
|
|
45
|
+
require('node:path').resolve(__dirname, `../generated/prisma-${dbType}`),
|
|
70
46
|
// Local development location (relative to core package)
|
|
71
47
|
`../generated/prisma-${dbType}`,
|
|
72
48
|
];
|
|
73
49
|
|
|
74
|
-
for (const
|
|
50
|
+
for (const candidate of paths) {
|
|
75
51
|
try {
|
|
76
|
-
return require(
|
|
52
|
+
return require(candidate).PrismaClient;
|
|
77
53
|
} catch (err) {
|
|
78
54
|
// Continue to next path
|
|
79
55
|
}
|
|
@@ -103,9 +79,13 @@ const prismaClientSingleton = () => {
|
|
|
103
79
|
errorFormat: 'pretty',
|
|
104
80
|
});
|
|
105
81
|
|
|
82
|
+
// Throws when a deployed runtime has no encryption key: the app must not
|
|
83
|
+
// start and write sensitive fields in plaintext.
|
|
106
84
|
const encryptionConfig = getEncryptionConfig();
|
|
107
85
|
|
|
108
86
|
if (encryptionConfig.enabled) {
|
|
87
|
+
// Fail closed: if the extension cannot be installed, do not hand out
|
|
88
|
+
// a client that would write plaintext.
|
|
109
89
|
try {
|
|
110
90
|
// Load custom encryption schema from appDefinition before creating extension
|
|
111
91
|
loadCustomEncryptionSchema();
|
|
@@ -120,17 +100,14 @@ const prismaClientSingleton = () => {
|
|
|
120
100
|
enabled: true,
|
|
121
101
|
})
|
|
122
102
|
);
|
|
123
|
-
|
|
124
|
-
logger.info(
|
|
125
|
-
`Field-level encryption enabled using ${encryptionConfig.method.toUpperCase()}`
|
|
126
|
-
);
|
|
127
103
|
} catch (error) {
|
|
128
|
-
logger.error(
|
|
129
|
-
|
|
130
|
-
error
|
|
131
|
-
);
|
|
132
|
-
logger.warn('Continuing without encryption...');
|
|
104
|
+
logger.error('Failed to initialize encryption extension:', error);
|
|
105
|
+
throw error;
|
|
133
106
|
}
|
|
107
|
+
|
|
108
|
+
logger.info(
|
|
109
|
+
`Field-level encryption enabled using ${encryptionConfig.method.toUpperCase()}`
|
|
110
|
+
);
|
|
134
111
|
} else {
|
|
135
112
|
logger.info('Field-level encryption disabled');
|
|
136
113
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/** Mongo/DocumentDB duplicate-key error code. */
|
|
2
|
+
const DUPLICATE_KEY_CODE = 11000;
|
|
3
|
+
/** Prisma's unique-constraint error code (PostgreSQL and MongoDB). */
|
|
4
|
+
const PRISMA_UNIQUE_CODE = 'P2002';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Whether `error` is a unique-constraint violation, however the database
|
|
8
|
+
* layer raised it: a Prisma `P2002`, or a duplicate-key `11000`
|
|
9
|
+
* (`documentdb-utils` `insertOne` sets `code` on the error it throws).
|
|
10
|
+
* Matches on the code only, never on message text.
|
|
11
|
+
*
|
|
12
|
+
* @param {unknown} error
|
|
13
|
+
* @returns {boolean}
|
|
14
|
+
*/
|
|
15
|
+
function isUniqueViolation(error) {
|
|
16
|
+
return (
|
|
17
|
+
error?.code === PRISMA_UNIQUE_CODE || error?.code === DUPLICATE_KEY_CODE
|
|
18
|
+
);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
module.exports = {
|
|
22
|
+
isUniqueViolation,
|
|
23
|
+
DUPLICATE_KEY_CODE,
|
|
24
|
+
PRISMA_UNIQUE_CODE,
|
|
25
|
+
};
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
const {
|
|
2
|
+
resolveEncryptionConfig,
|
|
3
|
+
OPT_OUT_VAR,
|
|
4
|
+
} = require('../encryption/encryption-config');
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Reports whether field-level encryption is on and working, using the same
|
|
8
|
+
* rule the Prisma client applies at startup (encryption/encryption-config.js).
|
|
9
|
+
*/
|
|
1
10
|
class CheckEncryptionHealthUseCase {
|
|
2
11
|
constructor({ testEncryptionUseCase }) {
|
|
3
12
|
this.testEncryptionUseCase = testEncryptionUseCase;
|
|
@@ -5,78 +14,60 @@ class CheckEncryptionHealthUseCase {
|
|
|
5
14
|
|
|
6
15
|
async execute() {
|
|
7
16
|
const config = this._getEncryptionConfiguration();
|
|
17
|
+
const summary = {
|
|
18
|
+
mode: config.mode,
|
|
19
|
+
bypassed: config.bypassed,
|
|
20
|
+
optedOut: config.optedOut,
|
|
21
|
+
runtime: config.runtime,
|
|
22
|
+
stage: config.stage,
|
|
23
|
+
debug: {
|
|
24
|
+
hasKMS: config.hasKMS,
|
|
25
|
+
hasAES: config.hasAES,
|
|
26
|
+
},
|
|
27
|
+
};
|
|
8
28
|
|
|
9
|
-
if (config.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
29
|
+
if (config.error) {
|
|
30
|
+
return {
|
|
31
|
+
status: 'unhealthy',
|
|
32
|
+
...summary,
|
|
33
|
+
testResult: config.error,
|
|
34
|
+
encryptionWorks: false,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
13
37
|
|
|
38
|
+
if (!config.enabled) {
|
|
14
39
|
return {
|
|
15
40
|
status: 'disabled',
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
stage: config.stage,
|
|
19
|
-
testResult,
|
|
41
|
+
...summary,
|
|
42
|
+
testResult: this._disabledReason(config),
|
|
20
43
|
encryptionWorks: false,
|
|
21
|
-
debug: {
|
|
22
|
-
hasKMS: config.hasKMS,
|
|
23
|
-
hasAES: config.hasAES,
|
|
24
|
-
},
|
|
25
44
|
};
|
|
26
45
|
}
|
|
27
46
|
|
|
28
47
|
try {
|
|
29
48
|
const testResults = await this.testEncryptionUseCase.execute();
|
|
30
|
-
|
|
31
|
-
return {
|
|
32
|
-
...testResults,
|
|
33
|
-
mode: config.mode,
|
|
34
|
-
bypassed: config.isBypassed,
|
|
35
|
-
stage: config.stage,
|
|
36
|
-
debug: {
|
|
37
|
-
hasKMS: config.hasKMS,
|
|
38
|
-
hasAES: config.hasAES,
|
|
39
|
-
},
|
|
40
|
-
};
|
|
49
|
+
return { ...testResults, ...summary };
|
|
41
50
|
} catch (error) {
|
|
42
51
|
return {
|
|
43
52
|
status: 'unhealthy',
|
|
44
|
-
|
|
45
|
-
bypassed: config.isBypassed,
|
|
46
|
-
stage: config.stage,
|
|
53
|
+
...summary,
|
|
47
54
|
testResult: `Encryption test failed: ${error.message}`,
|
|
48
55
|
encryptionWorks: false,
|
|
49
|
-
debug: {
|
|
50
|
-
hasKMS: config.hasKMS,
|
|
51
|
-
hasAES: config.hasAES,
|
|
52
|
-
},
|
|
53
56
|
};
|
|
54
57
|
}
|
|
55
58
|
}
|
|
56
59
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
? BYPASS_ENCRYPTION_STAGE.split(',').map((s) => s.trim())
|
|
65
|
-
: defaultBypassStages;
|
|
66
|
-
|
|
67
|
-
const isBypassed = bypassStages.includes(STAGE);
|
|
68
|
-
const hasAES = AES_KEY_ID && AES_KEY_ID.trim() !== '';
|
|
69
|
-
const hasKMS = KMS_KEY_ARN && KMS_KEY_ARN.trim() !== '';
|
|
70
|
-
// Prefer KMS over AES when both are configured (KMS is more secure)
|
|
71
|
-
const mode = hasKMS ? 'kms' : hasAES ? 'aes' : 'none';
|
|
60
|
+
_disabledReason(config) {
|
|
61
|
+
if (config.bypassed) return 'Encryption bypassed for this stage';
|
|
62
|
+
if (config.optedOut) {
|
|
63
|
+
return `Encryption explicitly disabled (${OPT_OUT_VAR}=true); sensitive fields are stored in plaintext`;
|
|
64
|
+
}
|
|
65
|
+
return 'No encryption keys configured';
|
|
66
|
+
}
|
|
72
67
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
hasAES,
|
|
77
|
-
hasKMS,
|
|
78
|
-
mode,
|
|
79
|
-
};
|
|
68
|
+
_getEncryptionConfiguration() {
|
|
69
|
+
const config = resolveEncryptionConfig(process.env);
|
|
70
|
+
return { ...config, stage: process.env.STAGE || null };
|
|
80
71
|
}
|
|
81
72
|
}
|
|
82
73
|
|
package/errors/index.js
CHANGED
|
@@ -6,9 +6,6 @@ const {
|
|
|
6
6
|
ParameterTypeError,
|
|
7
7
|
} = require('./validation-errors');
|
|
8
8
|
const { ClientSafeError } = require('./client-safe-error');
|
|
9
|
-
const {
|
|
10
|
-
MappingAlreadyExistsError,
|
|
11
|
-
} = require('./mapping-already-exists-error');
|
|
12
9
|
|
|
13
10
|
module.exports = {
|
|
14
11
|
BaseError,
|
|
@@ -17,5 +14,4 @@ module.exports = {
|
|
|
17
14
|
RequiredPropertyError,
|
|
18
15
|
ParameterTypeError,
|
|
19
16
|
ClientSafeError,
|
|
20
|
-
MappingAlreadyExistsError,
|
|
21
17
|
};
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bootstrap Runner
|
|
3
|
+
*
|
|
4
|
+
* Runs extension bootstrap functions in sequence.
|
|
5
|
+
* Bootstrap hooks execute AFTER database connection but BEFORE integration
|
|
6
|
+
* router creation. This is the right place for extensions to:
|
|
7
|
+
*
|
|
8
|
+
* - Load credentials from database into integration definitions
|
|
9
|
+
* - Register additional middleware or services
|
|
10
|
+
* - Perform one-time initialization
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* await runExtensionBootstraps(extensions, { prisma, appDefinition });
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Runs all extension bootstrap functions in sequence.
|
|
18
|
+
*
|
|
19
|
+
* @param {Array<Object>} extensions - Normalized extensions (from extension-loader)
|
|
20
|
+
* @param {Object} context
|
|
21
|
+
* @param {Object} context.prisma - Prisma client instance
|
|
22
|
+
* @param {Object} context.appDefinition - Full app definition
|
|
23
|
+
* @throws {Error} If any bootstrap function fails (fails fast)
|
|
24
|
+
*/
|
|
25
|
+
async function runExtensionBootstraps(extensions, context = {}) {
|
|
26
|
+
if (!extensions || extensions.length === 0) return;
|
|
27
|
+
|
|
28
|
+
const { prisma, appDefinition } = context;
|
|
29
|
+
|
|
30
|
+
for (const ext of extensions) {
|
|
31
|
+
if (!ext.bootstrap) continue;
|
|
32
|
+
|
|
33
|
+
try {
|
|
34
|
+
await ext.bootstrap(prisma, appDefinition);
|
|
35
|
+
} catch (error) {
|
|
36
|
+
throw new Error(
|
|
37
|
+
`Extension "${ext.name}" bootstrap failed: ${error.message}`
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
module.exports = { runExtensionBootstraps };
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Extension Loader
|
|
3
|
+
*
|
|
4
|
+
* Validates and normalizes the core extensions of the app definition
|
|
5
|
+
* (`appDefinition.coreExtensions`, an array). Core extensions add custom
|
|
6
|
+
* Prisma models, encryption schemas, admin routes and bootstrap logic to a
|
|
7
|
+
* Frigg app. The key is `coreExtensions`, not `extensions`: ADR-017 keeps
|
|
8
|
+
* `appDefinition.extensions` for its keyed object form.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* const extensions = loadExtensions(appDefinition);
|
|
12
|
+
* // extensions is a normalized array, safe to iterate
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
const path = require('path');
|
|
16
|
+
const {
|
|
17
|
+
coreExtensionRoutePathError,
|
|
18
|
+
} = require('../management-api/route-registry');
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Validates a single extension definition.
|
|
22
|
+
* @param {Object} ext - Raw extension config from app definition
|
|
23
|
+
* @param {number} index - Position in the coreExtensions array (for error messages)
|
|
24
|
+
* @returns {{valid: boolean, errors: string[]}}
|
|
25
|
+
*/
|
|
26
|
+
function validateExtension(ext, index) {
|
|
27
|
+
const prefix = `coreExtensions[${index}]`;
|
|
28
|
+
const errors = [];
|
|
29
|
+
|
|
30
|
+
if (!ext || typeof ext !== 'object') {
|
|
31
|
+
errors.push(`${prefix}: must be an object`);
|
|
32
|
+
return { valid: false, errors };
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
if (!ext.name || typeof ext.name !== 'string') {
|
|
36
|
+
errors.push(`${prefix}.name: required string`);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// schema is optional — path to a .prisma file
|
|
40
|
+
if (ext.schema !== undefined) {
|
|
41
|
+
if (typeof ext.schema !== 'string') {
|
|
42
|
+
errors.push(`${prefix}.schema: must be a string (path to .prisma file)`);
|
|
43
|
+
} else if (!ext.schema.endsWith('.prisma')) {
|
|
44
|
+
errors.push(`${prefix}.schema: must end with .prisma`);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// encryption is optional — object with model names → { fields: [...] }
|
|
49
|
+
if (ext.encryption !== undefined) {
|
|
50
|
+
if (!ext.encryption || typeof ext.encryption !== 'object') {
|
|
51
|
+
errors.push(`${prefix}.encryption: must be an object`);
|
|
52
|
+
} else {
|
|
53
|
+
for (const [model, config] of Object.entries(ext.encryption)) {
|
|
54
|
+
if (!config || !Array.isArray(config.fields)) {
|
|
55
|
+
errors.push(
|
|
56
|
+
`${prefix}.encryption.${model}: must have a "fields" array`
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// routes is optional — { path, handler }
|
|
64
|
+
if (ext.routes !== undefined) {
|
|
65
|
+
if (!ext.routes || typeof ext.routes !== 'object') {
|
|
66
|
+
errors.push(`${prefix}.routes: must be an object with { path, handler }`);
|
|
67
|
+
} else {
|
|
68
|
+
if (!ext.routes.path || typeof ext.routes.path !== 'string') {
|
|
69
|
+
errors.push(`${prefix}.routes.path: required string`);
|
|
70
|
+
} else {
|
|
71
|
+
const pathError = coreExtensionRoutePathError(ext.routes.path);
|
|
72
|
+
if (pathError) {
|
|
73
|
+
errors.push(`${prefix}.routes.path: ${pathError}`);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
if (!ext.routes.handler) {
|
|
77
|
+
errors.push(`${prefix}.routes.handler: required (function or module path)`);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// bootstrap is optional — function or module path
|
|
83
|
+
if (ext.bootstrap !== undefined) {
|
|
84
|
+
if (typeof ext.bootstrap !== 'function' && typeof ext.bootstrap !== 'string') {
|
|
85
|
+
errors.push(
|
|
86
|
+
`${prefix}.bootstrap: must be a function or a string (module path)`
|
|
87
|
+
);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
return { valid: errors.length === 0, errors };
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Loads and validates extensions from the app definition.
|
|
96
|
+
*
|
|
97
|
+
* @param {Object} appDefinition - The full app definition
|
|
98
|
+
* @returns {Array<Object>} Normalized extensions array (empty if none)
|
|
99
|
+
* @throws {Error} If any extension fails validation
|
|
100
|
+
*/
|
|
101
|
+
function loadExtensions(appDefinition) {
|
|
102
|
+
if (!appDefinition) return [];
|
|
103
|
+
|
|
104
|
+
// The array this loader reads used to be `appDefinition.extensions`;
|
|
105
|
+
// that key now belongs to ADR-017's keyed object. An array there is the
|
|
106
|
+
// old spelling: stop at load rather than silently dropping the extensions.
|
|
107
|
+
if (Array.isArray(appDefinition.extensions)) {
|
|
108
|
+
throw new Error(
|
|
109
|
+
'appDefinition.extensions (array) was renamed to appDefinition.coreExtensions; ' +
|
|
110
|
+
'move the array to coreExtensions'
|
|
111
|
+
);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
const raw = appDefinition.coreExtensions;
|
|
115
|
+
if (!raw) return [];
|
|
116
|
+
|
|
117
|
+
if (!Array.isArray(raw)) {
|
|
118
|
+
throw new Error('appDefinition.coreExtensions must be an array');
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
if (raw.length === 0) return [];
|
|
122
|
+
|
|
123
|
+
const allErrors = [];
|
|
124
|
+
|
|
125
|
+
const normalized = raw.map((ext, index) => {
|
|
126
|
+
const { valid, errors } = validateExtension(ext, index);
|
|
127
|
+
if (!valid) {
|
|
128
|
+
allErrors.push(...errors);
|
|
129
|
+
return null;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
// Normalize bootstrap — resolve string paths to functions
|
|
133
|
+
let bootstrapFn = null;
|
|
134
|
+
if (typeof ext.bootstrap === 'function') {
|
|
135
|
+
bootstrapFn = ext.bootstrap;
|
|
136
|
+
} else if (typeof ext.bootstrap === 'string') {
|
|
137
|
+
bootstrapFn = require(ext.bootstrap);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// Normalize route handler — resolve string paths to functions
|
|
141
|
+
let routeHandler = null;
|
|
142
|
+
if (ext.routes) {
|
|
143
|
+
if (typeof ext.routes.handler === 'function') {
|
|
144
|
+
routeHandler = ext.routes.handler;
|
|
145
|
+
} else if (typeof ext.routes.handler === 'string') {
|
|
146
|
+
routeHandler = require(ext.routes.handler);
|
|
147
|
+
} else {
|
|
148
|
+
routeHandler = ext.routes.handler;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
return {
|
|
153
|
+
name: ext.name,
|
|
154
|
+
schema: ext.schema || null,
|
|
155
|
+
encryption: ext.encryption || null,
|
|
156
|
+
routes: ext.routes
|
|
157
|
+
? { path: ext.routes.path, handler: routeHandler }
|
|
158
|
+
: null,
|
|
159
|
+
bootstrap: bootstrapFn,
|
|
160
|
+
};
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
if (allErrors.length > 0) {
|
|
164
|
+
throw new Error(
|
|
165
|
+
`Invalid extension configuration:\n- ${allErrors.join('\n- ')}`
|
|
166
|
+
);
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
return normalized.filter(Boolean);
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Get extension schema file paths from loaded extensions.
|
|
174
|
+
* @param {Array<Object>} extensions - Normalized extensions
|
|
175
|
+
* @returns {string[]} Array of absolute paths to .prisma schema files
|
|
176
|
+
*/
|
|
177
|
+
function getExtensionSchemaPaths(extensions) {
|
|
178
|
+
return extensions
|
|
179
|
+
.filter((ext) => ext.schema)
|
|
180
|
+
.map((ext) => ext.schema);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
module.exports = {
|
|
184
|
+
loadExtensions,
|
|
185
|
+
validateExtension,
|
|
186
|
+
getExtensionSchemaPaths,
|
|
187
|
+
};
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Frigg Extension System
|
|
3
|
+
*
|
|
4
|
+
* Extensions allow integration developers to extend Frigg Core with:
|
|
5
|
+
* - Custom Prisma models (schema composition)
|
|
6
|
+
* - Encrypted fields (encryption registry merge)
|
|
7
|
+
* - Admin API routes (route mounting)
|
|
8
|
+
* - Bootstrap lifecycle hooks (credential loading, etc.)
|
|
9
|
+
*
|
|
10
|
+
* @module @friggframework/core/extensions
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
const { loadExtensions, validateExtension, getExtensionSchemaPaths } = require('./extension-loader');
|
|
14
|
+
const { composeSchemas, extractModelBlocks, getSchemaFilePaths } = require('./schema-composer');
|
|
15
|
+
const {
|
|
16
|
+
mountExtensionRoutes,
|
|
17
|
+
createExtensionRoutesRouter,
|
|
18
|
+
} = require('./route-mounter');
|
|
19
|
+
const { runExtensionBootstraps } = require('./bootstrap-runner');
|
|
20
|
+
const { initializeApp, resetInitialization } = require('./initialize-app');
|
|
21
|
+
|
|
22
|
+
module.exports = {
|
|
23
|
+
// Extension loading & validation
|
|
24
|
+
loadExtensions,
|
|
25
|
+
validateExtension,
|
|
26
|
+
getExtensionSchemaPaths,
|
|
27
|
+
|
|
28
|
+
// Schema composition
|
|
29
|
+
composeSchemas,
|
|
30
|
+
extractModelBlocks,
|
|
31
|
+
getSchemaFilePaths,
|
|
32
|
+
|
|
33
|
+
// Route mounting
|
|
34
|
+
mountExtensionRoutes,
|
|
35
|
+
createExtensionRoutesRouter,
|
|
36
|
+
|
|
37
|
+
// Bootstrap lifecycle
|
|
38
|
+
runExtensionBootstraps,
|
|
39
|
+
initializeApp,
|
|
40
|
+
resetInitialization,
|
|
41
|
+
};
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Application Initialization with Extension Lifecycle
|
|
3
|
+
*
|
|
4
|
+
* Provides an async initialization function that runs extension bootstraps
|
|
5
|
+
* after database connection but before router creation. This is the integration
|
|
6
|
+
* point for providers (Lambda, Netlify) to hook into the extension lifecycle.
|
|
7
|
+
*
|
|
8
|
+
* Call `initializeApp()` during the async startup phase of your handler/function.
|
|
9
|
+
* It is safe to call multiple times — subsequent calls are no-ops.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* const { initializeApp } = require('@friggframework/core/extensions/initialize-app');
|
|
13
|
+
*
|
|
14
|
+
* // In a Lambda handler or Netlify function:
|
|
15
|
+
* await initializeApp();
|
|
16
|
+
* // Now extensions are bootstrapped and router can be created
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
const { loadExtensions } = require('./extension-loader');
|
|
20
|
+
const { runExtensionBootstraps } = require('./bootstrap-runner');
|
|
21
|
+
|
|
22
|
+
let _initialized = false;
|
|
23
|
+
let _initPromise = null;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Initializes extensions by running bootstrap hooks.
|
|
27
|
+
*
|
|
28
|
+
* This function:
|
|
29
|
+
* 1. Loads the app definition
|
|
30
|
+
* 2. Loads and validates extensions
|
|
31
|
+
* 3. Runs extension bootstrap hooks in sequence
|
|
32
|
+
*
|
|
33
|
+
* Bootstrap hooks receive (prisma, appDefinition) and can:
|
|
34
|
+
* - Load credentials from database into integration Definition.env
|
|
35
|
+
* - Register services or middleware
|
|
36
|
+
* - Perform any one-time async initialization
|
|
37
|
+
*
|
|
38
|
+
* @param {Object} [options]
|
|
39
|
+
* @param {Object} [options.appDefinition] - Override app definition (skips loadAppDefinition)
|
|
40
|
+
* @param {Object} [options.prisma] - Override Prisma client instance
|
|
41
|
+
* @param {boolean} [options.force=false] - Force re-initialization
|
|
42
|
+
* @returns {Promise<{extensions: Array}>} The loaded extensions
|
|
43
|
+
*/
|
|
44
|
+
async function initializeApp(options = {}) {
|
|
45
|
+
const { force = false } = options;
|
|
46
|
+
|
|
47
|
+
// Return cached promise if already initializing (prevent race conditions)
|
|
48
|
+
if (_initPromise && !force) {
|
|
49
|
+
return _initPromise;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
if (_initialized && !force) {
|
|
53
|
+
return { extensions: [] };
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
_initPromise = _doInitialize(options);
|
|
57
|
+
|
|
58
|
+
try {
|
|
59
|
+
const result = await _initPromise;
|
|
60
|
+
_initialized = true;
|
|
61
|
+
return result;
|
|
62
|
+
} catch (error) {
|
|
63
|
+
_initPromise = null;
|
|
64
|
+
throw error;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
async function _doInitialize(options = {}) {
|
|
69
|
+
let { appDefinition, prisma } = options;
|
|
70
|
+
|
|
71
|
+
// Load app definition if not provided
|
|
72
|
+
if (!appDefinition) {
|
|
73
|
+
try {
|
|
74
|
+
const { loadAppDefinition } = require('../handlers/app-definition-loader');
|
|
75
|
+
const loaded = loadAppDefinition();
|
|
76
|
+
appDefinition = loaded.appDefinition;
|
|
77
|
+
} catch {
|
|
78
|
+
// No app definition available — skip extension bootstrap
|
|
79
|
+
return { extensions: [] };
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
if (!appDefinition) {
|
|
84
|
+
return { extensions: [] };
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
// Load extensions
|
|
88
|
+
const extensions = loadExtensions(appDefinition);
|
|
89
|
+
|
|
90
|
+
if (extensions.length === 0) {
|
|
91
|
+
return { extensions };
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Get Prisma client if not provided
|
|
95
|
+
if (!prisma) {
|
|
96
|
+
try {
|
|
97
|
+
const db = require('../database/prisma');
|
|
98
|
+
prisma = db.prisma;
|
|
99
|
+
} catch {
|
|
100
|
+
// Prisma not available — skip bootstrap
|
|
101
|
+
console.warn('Prisma client not available, skipping extension bootstraps');
|
|
102
|
+
return { extensions };
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// Run bootstrap hooks
|
|
107
|
+
await runExtensionBootstraps(extensions, { prisma, appDefinition });
|
|
108
|
+
|
|
109
|
+
return { extensions };
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Reset initialization state (for testing).
|
|
114
|
+
*/
|
|
115
|
+
function resetInitialization() {
|
|
116
|
+
_initialized = false;
|
|
117
|
+
_initPromise = null;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
module.exports = {
|
|
121
|
+
initializeApp,
|
|
122
|
+
resetInitialization,
|
|
123
|
+
};
|