@terreno/api 57.3.0 → 57.6.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/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +11 -5
- package/bunfig.toml +1 -1
- package/dist/actions.js +197 -368
- package/dist/adminModelRouter.js +88 -173
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +601 -792
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +114 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +101 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +69 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +140 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +56 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +41 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +251 -0
- package/dist/auth.js +432 -681
- package/dist/authRecovery.js +155 -269
- package/dist/authTokens.js +43 -118
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthApp.js +25 -26
- package/dist/betterAuthSetup.js +258 -413
- package/dist/browserLogsRoute.d.ts +6 -0
- package/dist/browserLogsRoute.js +97 -0
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +43 -33
- package/dist/config.js +53 -122
- package/dist/configurationApp.js +180 -361
- package/dist/configurationPlugin.js +130 -302
- package/dist/consentApp.js +276 -421
- package/dist/docLoader.js +78 -126
- package/dist/envConfigurationPlugin.js +25 -147
- package/dist/errors.js +151 -247
- package/dist/example.js +28 -34
- package/dist/expressServer.d.ts +10 -0
- package/dist/expressServer.js +109 -255
- package/dist/frameworkModelNames.d.ts +24 -0
- package/dist/frameworkModelNames.js +31 -0
- package/dist/githubAuth.js +152 -216
- package/dist/httpClient.js +176 -264
- package/dist/index.d.ts +28 -1
- package/dist/index.js +53 -2
- package/dist/logger.js +145 -278
- package/dist/mcp/auth.js +76 -128
- package/dist/mcp/createMCPRequest.js +4 -5
- package/dist/mcp/handlers.js +268 -480
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +57 -151
- package/dist/mcp/registry.js +17 -30
- package/dist/mcp/schemaGenerator.js +95 -181
- package/dist/mcp/server.js +28 -100
- package/dist/mcp/serviceTokens.js +102 -191
- package/dist/mcp/toolGenerator.js +78 -191
- package/dist/middleware.js +15 -27
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +9 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +9 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +7 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +7 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +7 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +9 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +155 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +110 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +73 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +249 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +185 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/consentForm.js +6 -6
- package/dist/models/consentResponse.js +5 -5
- package/dist/models/mcpServiceToken.js +66 -156
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/models/versionConfig.js +5 -5
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +183 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +156 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +32 -0
- package/dist/notifiers/googleChatNotifier.js +36 -117
- package/dist/notifiers/slackNotifier.d.ts +31 -2
- package/dist/notifiers/slackNotifier.js +170 -119
- package/dist/notifiers/zoomNotifier.js +60 -111
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +113 -127
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiBuilder.js +117 -159
- package/dist/openApiCompat.js +81 -148
- package/dist/openApiEtag.js +7 -7
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +301 -246
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +128 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +38 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +66 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +200 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +113 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +416 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +95 -211
- package/dist/plugins.js +125 -218
- package/dist/populate.js +130 -240
- package/dist/rateLimit/applyTrustProxy.js +1 -1
- package/dist/rateLimit/createStore.js +7 -8
- package/dist/rateLimit/memoryStore.js +22 -100
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +49 -101
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +55 -112
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +44 -80
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +40 -133
- package/dist/rbac/access.js +122 -253
- package/dist/rbac/assertAllowed.js +95 -171
- package/dist/rbac/auditModel.js +14 -58
- package/dist/rbac/backfillAdmins.js +24 -130
- package/dist/rbac/fieldViews.js +46 -141
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +51 -0
- package/dist/rbac/middleware.js +30 -96
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +133 -307
- package/dist/rbac/permissionUtils.js +40 -179
- package/dist/rbac/realtimeAccess.js +81 -147
- package/dist/rbac/resolve.d.ts +1 -1
- package/dist/rbac/resolve.js +154 -319
- package/dist/rbac/roleManager.js +318 -700
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +60 -173
- package/dist/rbac/routes.js +93 -196
- package/dist/rbac/scopes.js +39 -133
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +42 -93
- package/dist/rbac/types.d.ts +5 -0
- package/dist/rbac/userPlugin.js +3 -29
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +499 -764
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +9 -10
- package/dist/realtime/queryMatcher.js +110 -191
- package/dist/realtime/queryStore.js +35 -118
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +248 -401
- package/dist/realtime/registry.js +19 -30
- package/dist/realtime/sessionRevalidation.js +132 -358
- package/dist/realtime/socketAuth.js +89 -208
- package/dist/realtime/socketUser.js +10 -56
- package/dist/requestContext.js +93 -139
- package/dist/schemaMetadata.js +181 -265
- package/dist/scriptRunner.js +96 -266
- package/dist/scrubAdminFields.js +36 -108
- package/dist/secretProviders.js +130 -299
- package/dist/seedRunner.js +221 -514
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +82 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +25 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +176 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +425 -598
- package/dist/sync/loadHarness.js +392 -689
- package/dist/sync/models.js +181 -341
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +549 -697
- package/dist/sync/registrationSideEffects.js +41 -95
- package/dist/sync/registry.js +31 -47
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +484 -760
- package/dist/sync/scripts/compactTombstones.js +83 -228
- package/dist/sync/serialize.js +18 -58
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +271 -402
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +54 -116
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +14 -16
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +63 -168
- package/dist/sync/syncSeqPlugin.js +430 -702
- package/dist/sync/types.d.ts +18 -0
- package/dist/syncConsents.js +113 -253
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +184 -257
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +147 -259
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +23 -56
- package/dist/tests/mongoTestSetup.js +42 -103
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +32 -101
- package/dist/tests.js +12 -51
- package/dist/transformers.js +61 -164
- package/dist/types/authToken.d.ts +3 -3
- package/dist/types/mcpServiceToken.d.ts +2 -2
- package/dist/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.js +2 -0
- package/dist/utils.js +31 -93
- package/dist/vendor/wesleytodd-openapi/index.js +37 -51
- package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
- package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
- package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
- package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
- package/dist/versionCheckPlugin.js +52 -100
- package/dist/webhooks/headerValue.js +2 -2
- package/dist/webhooks/idempotency/memoryStore.js +16 -59
- package/dist/webhooks/idempotency/mongoStore.js +55 -130
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +14 -14
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +2 -1
- package/dist/webhooks/timingSafeEqual.js +4 -5
- package/dist/webhooks/verifiers/hmac.js +17 -18
- package/dist/webhooks/verifiers/sendgrid.js +20 -22
- package/dist/webhooks/verifiers/stripe.js +31 -65
- package/dist/webhooks/verifiers/twilio.js +23 -73
- package/dist/webhooks/webhooksApp.js +78 -177
- package/dist/zodOpenApi.js +2 -2
- package/package.json +34 -28
- package/src/__snapshots__/openApi.test.ts.snap +192 -54
- package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
- package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
- package/src/__tests__/browserLogsRoute.test.ts +165 -0
- package/src/adminTypes.ts +8 -0
- package/src/api.test.ts +39 -2
- package/src/api.ts +68 -0
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +160 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +329 -0
- package/src/auth.test.ts +1 -1
- package/src/auth.ts +1 -1
- package/src/authRecovery.test.ts +43 -0
- package/src/authRecovery.ts +16 -10
- package/src/authTokens.ts +6 -2
- package/src/authVerification.test.ts +22 -0
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/browserLogsRoute.ts +110 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/configurationPlugin.test.ts +1 -11
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/expressServer.ts +10 -0
- package/src/frameworkModelNames.test.ts +62 -0
- package/src/frameworkModelNames.ts +33 -0
- package/src/index.ts +76 -0
- package/src/isolated/migrateCliConnect.isolated.ts +51 -0
- package/src/mcp/auth.test.ts +34 -1
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/query.ts +3 -3
- package/src/mcp/toolGenerator.test.ts +81 -0
- package/src/migrations/cli.test.ts +353 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/mcpServiceToken.ts +4 -3
- package/src/models/notification.ts +69 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +528 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/notifiers/slackNotifier.test.ts +186 -1
- package/src/notifiers/slackNotifier.ts +167 -8
- package/src/openApi.test.ts +0 -1
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.ts +14 -3
- package/src/openApiValidator.test.ts +221 -2
- package/src/openApiValidator.ts +218 -33
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +262 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/plugins.test.ts +5 -0
- package/src/plugins.ts +3 -0
- package/src/rateLimit/middleware.ts +1 -1
- package/src/rateLimit/mongoStore.ts +1 -0
- package/src/rateLimit/policies.ts +2 -2
- package/src/rateLimit/redisStore.ts +1 -0
- package/src/rbac/access.ts +11 -3
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.ts +3 -0
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +26 -7
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.ts +1 -0
- package/src/realtime/realtime.test.ts +357 -185
- package/src/realtime/realtimeApp.ts +2 -1
- package/src/schemaMetadata.test.ts +14 -0
- package/src/schemaMetadata.ts +5 -5
- package/src/sync/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -0
- package/src/sync/executors.ts +33 -6
- package/src/sync/integration.test.ts +2 -2
- package/src/sync/mutationHandler.test.ts +277 -1
- package/src/sync/mutationHandler.ts +171 -29
- package/src/sync/registry.ts +4 -0
- package/src/sync/routes.ts +52 -8
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +3 -2
- package/src/sync/syncApp.ts +2 -1
- package/src/sync/syncBatch.ts +7 -2
- package/src/sync/syncRoutes.test.ts +297 -3
- package/src/sync/syncSocket.test.ts +229 -0
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +97 -31
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +10 -2
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +2 -4
- package/src/types/mcpServiceToken.ts +1 -7
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -0
- package/src/types.d.ts +1 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +8 -10
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +13 -54
- package/tsconfig.typedoc.json +4 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Notification = void 0;
|
|
7
|
+
const mongoose_1 = __importDefault(require("mongoose"));
|
|
8
|
+
const plugins_1 = require("../plugins");
|
|
9
|
+
const syncSeqPlugin_1 = require("../sync/syncSeqPlugin");
|
|
10
|
+
const notificationSchema = new mongoose_1.default.Schema({
|
|
11
|
+
_id: {
|
|
12
|
+
default: () => new mongoose_1.default.Types.ObjectId().toHexString(),
|
|
13
|
+
description: "The document id (string so offline sync clients can mint ids)",
|
|
14
|
+
type: String,
|
|
15
|
+
},
|
|
16
|
+
archivedAt: {
|
|
17
|
+
default: null,
|
|
18
|
+
description: "When the owner archived (dismissed) this notification; null means it is still in the active inbox",
|
|
19
|
+
type: Date,
|
|
20
|
+
},
|
|
21
|
+
body: {
|
|
22
|
+
description: "Main notification message text shown in the inbox",
|
|
23
|
+
required: true,
|
|
24
|
+
trim: true,
|
|
25
|
+
type: String,
|
|
26
|
+
},
|
|
27
|
+
href: {
|
|
28
|
+
description: "Optional deep link or in-app route opened when the user taps the notification",
|
|
29
|
+
trim: true,
|
|
30
|
+
type: String,
|
|
31
|
+
},
|
|
32
|
+
kind: {
|
|
33
|
+
description: "Optional category string used for icons or grouping in the UI",
|
|
34
|
+
trim: true,
|
|
35
|
+
type: String,
|
|
36
|
+
},
|
|
37
|
+
ownerId: {
|
|
38
|
+
description: "The user who owns this inbox row",
|
|
39
|
+
ref: "User",
|
|
40
|
+
required: true,
|
|
41
|
+
type: mongoose_1.default.Schema.Types.ObjectId,
|
|
42
|
+
},
|
|
43
|
+
readAt: {
|
|
44
|
+
default: null,
|
|
45
|
+
description: "When the owner marked this notification as read; null means unread",
|
|
46
|
+
type: Date,
|
|
47
|
+
},
|
|
48
|
+
title: {
|
|
49
|
+
description: "Short headline shown in the inbox list",
|
|
50
|
+
required: true,
|
|
51
|
+
trim: true,
|
|
52
|
+
type: String,
|
|
53
|
+
},
|
|
54
|
+
}, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
|
|
55
|
+
// biome-ignore assist/source/useSortedKeys: ownerId must lead the compound index for owner-scoped inbox queries
|
|
56
|
+
notificationSchema.index({ ownerId: 1, created: -1 });
|
|
57
|
+
notificationSchema.plugin(plugins_1.createdUpdatedPlugin);
|
|
58
|
+
notificationSchema.plugin(plugins_1.isDeletedPlugin);
|
|
59
|
+
notificationSchema.plugin(plugins_1.findExactlyOne);
|
|
60
|
+
notificationSchema.plugin(plugins_1.findOneOrNone);
|
|
61
|
+
notificationSchema.plugin(syncSeqPlugin_1.syncPlugin);
|
|
62
|
+
exports.Notification = mongoose_1.default.model("TerrenoInboxNotification", notificationSchema, "notifications");
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.NotificationPreference = void 0;
|
|
7
|
+
const mongoose_1 = __importDefault(require("mongoose"));
|
|
8
|
+
const plugins_1 = require("../plugins");
|
|
9
|
+
const syncSeqPlugin_1 = require("../sync/syncSeqPlugin");
|
|
10
|
+
const notificationPreferenceSchema = new mongoose_1.default.Schema({
|
|
11
|
+
_id: {
|
|
12
|
+
default: () => new mongoose_1.default.Types.ObjectId().toHexString(),
|
|
13
|
+
description: "The document id (string so offline sync clients can mint ids)",
|
|
14
|
+
type: String,
|
|
15
|
+
},
|
|
16
|
+
inapp: {
|
|
17
|
+
default: true,
|
|
18
|
+
description: "Whether in-app inbox rows are created for this user",
|
|
19
|
+
type: Boolean,
|
|
20
|
+
},
|
|
21
|
+
mail: {
|
|
22
|
+
default: true,
|
|
23
|
+
description: "Whether outbound email is sent for notifications",
|
|
24
|
+
type: Boolean,
|
|
25
|
+
},
|
|
26
|
+
ownerId: {
|
|
27
|
+
description: "The user these preferences belong to",
|
|
28
|
+
ref: "User",
|
|
29
|
+
required: true,
|
|
30
|
+
type: mongoose_1.default.Schema.Types.ObjectId,
|
|
31
|
+
},
|
|
32
|
+
push: {
|
|
33
|
+
default: true,
|
|
34
|
+
description: "Whether push notifications are sent for this user",
|
|
35
|
+
type: Boolean,
|
|
36
|
+
},
|
|
37
|
+
sms: {
|
|
38
|
+
default: true,
|
|
39
|
+
description: "Whether SMS messages are sent for this user",
|
|
40
|
+
type: Boolean,
|
|
41
|
+
},
|
|
42
|
+
}, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
|
|
43
|
+
notificationPreferenceSchema.plugin(plugins_1.createdUpdatedPlugin);
|
|
44
|
+
notificationPreferenceSchema.plugin(plugins_1.isDeletedPlugin);
|
|
45
|
+
notificationPreferenceSchema.plugin(plugins_1.findExactlyOne);
|
|
46
|
+
notificationPreferenceSchema.plugin(plugins_1.findOneOrNone);
|
|
47
|
+
notificationPreferenceSchema.plugin(syncSeqPlugin_1.syncPlugin);
|
|
48
|
+
notificationPreferenceSchema.index({ ownerId: 1 }, { partialFilterExpression: { deleted: false }, unique: true });
|
|
49
|
+
exports.NotificationPreference = mongoose_1.default.model("TerrenoNotificationPreference", notificationPreferenceSchema, "notificationpreferences");
|
|
@@ -2,12 +2,11 @@
|
|
|
2
2
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
|
-
var _a;
|
|
6
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
6
|
exports.VersionConfig = void 0;
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
7
|
+
const mongoose_1 = __importDefault(require("mongoose"));
|
|
8
|
+
const plugins_1 = require("../plugins");
|
|
9
|
+
const versionConfigSchema = new mongoose_1.default.Schema({
|
|
11
10
|
mobileRequiredVersion: {
|
|
12
11
|
default: 0,
|
|
13
12
|
description: "Build number at which mobile users are blocked from using the app",
|
|
@@ -72,4 +71,5 @@ versionConfigSchema.plugin(plugins_1.createdUpdatedPlugin);
|
|
|
72
71
|
versionConfigSchema.plugin(plugins_1.isDeletedPlugin);
|
|
73
72
|
versionConfigSchema.plugin(plugins_1.findOneOrNone);
|
|
74
73
|
versionConfigSchema.plugin(plugins_1.findExactlyOne);
|
|
75
|
-
exports.VersionConfig =
|
|
74
|
+
exports.VersionConfig = mongoose_1.default.models.VersionConfig ??
|
|
75
|
+
mongoose_1.default.model("VersionConfig", versionConfigSchema);
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { Model } from "mongoose";
|
|
2
|
+
import type { NotifyInput } from "../types/notification";
|
|
3
|
+
export interface NotificationsCommsService {
|
|
4
|
+
sendMail: (message: {
|
|
5
|
+
html?: string;
|
|
6
|
+
subject: string;
|
|
7
|
+
text?: string;
|
|
8
|
+
to: string;
|
|
9
|
+
}, options?: {
|
|
10
|
+
userId?: string;
|
|
11
|
+
}) => Promise<unknown>;
|
|
12
|
+
sendPushToUser: (message: {
|
|
13
|
+
body: string;
|
|
14
|
+
title: string;
|
|
15
|
+
userId: string;
|
|
16
|
+
}) => Promise<unknown[]>;
|
|
17
|
+
sendSms: (message: {
|
|
18
|
+
body: string;
|
|
19
|
+
to: string;
|
|
20
|
+
}, options?: {
|
|
21
|
+
userId?: string;
|
|
22
|
+
}) => Promise<unknown>;
|
|
23
|
+
}
|
|
24
|
+
export interface NotificationServiceOptions {
|
|
25
|
+
getComms?: () => NotificationsCommsService;
|
|
26
|
+
retainDays?: number;
|
|
27
|
+
userModel?: Model<{
|
|
28
|
+
email?: string;
|
|
29
|
+
phone?: string;
|
|
30
|
+
}>;
|
|
31
|
+
}
|
|
32
|
+
export interface NotificationService {
|
|
33
|
+
notify: (input: NotifyInput) => Promise<string>;
|
|
34
|
+
sweepExpired: () => Promise<number>;
|
|
35
|
+
}
|
|
36
|
+
export declare const assertValidNotificationReadAt: (readAt: unknown) => void;
|
|
37
|
+
export declare const assertValidNotificationArchivedAt: (archivedAt: unknown) => void;
|
|
38
|
+
export declare const createNotificationService: (options?: NotificationServiceOptions) => NotificationService;
|
|
39
|
+
export declare const configureNotificationService: (options: NotificationServiceOptions) => void;
|
|
40
|
+
export declare const getNotificationService: () => NotificationService;
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getNotificationService = exports.configureNotificationService = exports.createNotificationService = exports.assertValidNotificationArchivedAt = exports.assertValidNotificationReadAt = void 0;
|
|
4
|
+
const luxon_1 = require("luxon");
|
|
5
|
+
const errors_1 = require("../errors");
|
|
6
|
+
const logger_1 = require("../logger");
|
|
7
|
+
const notification_1 = require("../models/notification");
|
|
8
|
+
const notificationPreference_1 = require("../models/notificationPreference");
|
|
9
|
+
const escapeHtml = (value) => value.replace(/[&<>"']/g, (character) => ({
|
|
10
|
+
"'": "'",
|
|
11
|
+
'"': """,
|
|
12
|
+
"&": "&",
|
|
13
|
+
"<": "<",
|
|
14
|
+
">": ">",
|
|
15
|
+
})[character] ?? character);
|
|
16
|
+
const DEFAULT_PREFERENCES = {
|
|
17
|
+
inapp: true,
|
|
18
|
+
mail: true,
|
|
19
|
+
push: true,
|
|
20
|
+
sms: true,
|
|
21
|
+
};
|
|
22
|
+
const loadPreferences = async (userId) => {
|
|
23
|
+
const preference = await notificationPreference_1.NotificationPreference.findOneOrNone({ ownerId: userId });
|
|
24
|
+
if (!preference) {
|
|
25
|
+
return DEFAULT_PREFERENCES;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
inapp: preference.inapp,
|
|
29
|
+
mail: preference.mail,
|
|
30
|
+
push: preference.push,
|
|
31
|
+
sms: preference.sms,
|
|
32
|
+
};
|
|
33
|
+
};
|
|
34
|
+
const loadUser = async (userModel, userId) => {
|
|
35
|
+
if (!userModel) {
|
|
36
|
+
return undefined;
|
|
37
|
+
}
|
|
38
|
+
const user = await userModel.findById(userId).select("email phone").lean();
|
|
39
|
+
if (!user) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
return { email: user.email, phone: user.phone };
|
|
43
|
+
};
|
|
44
|
+
const isValidReadAt = (value) => {
|
|
45
|
+
if (value === null || value === undefined) {
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
if (value instanceof Date && !Number.isNaN(value.getTime())) {
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
if (typeof value === "string") {
|
|
52
|
+
const parsed = luxon_1.DateTime.fromISO(value);
|
|
53
|
+
return parsed.isValid;
|
|
54
|
+
}
|
|
55
|
+
return false;
|
|
56
|
+
};
|
|
57
|
+
const assertValidNotificationReadAt = (readAt) => {
|
|
58
|
+
if (!isValidReadAt(readAt)) {
|
|
59
|
+
throw new errors_1.APIError({ status: 400, title: "readAt must be a date or null" });
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
exports.assertValidNotificationReadAt = assertValidNotificationReadAt;
|
|
63
|
+
const assertValidNotificationArchivedAt = (archivedAt) => {
|
|
64
|
+
if (!isValidReadAt(archivedAt)) {
|
|
65
|
+
throw new errors_1.APIError({ status: 400, title: "archivedAt must be a date or null" });
|
|
66
|
+
}
|
|
67
|
+
};
|
|
68
|
+
exports.assertValidNotificationArchivedAt = assertValidNotificationArchivedAt;
|
|
69
|
+
const createNotificationService = (options = {}) => {
|
|
70
|
+
const retainDays = options.retainDays ?? 0;
|
|
71
|
+
const sweepExpired = async () => {
|
|
72
|
+
if (retainDays <= 0) {
|
|
73
|
+
return 0;
|
|
74
|
+
}
|
|
75
|
+
const cutoff = luxon_1.DateTime.now().minus({ days: retainDays }).toJSDate();
|
|
76
|
+
const stale = await notification_1.Notification.find({
|
|
77
|
+
created: { $lt: cutoff },
|
|
78
|
+
deleted: { $ne: true },
|
|
79
|
+
});
|
|
80
|
+
let tombstoned = 0;
|
|
81
|
+
for (const row of stale) {
|
|
82
|
+
row.deleted = true;
|
|
83
|
+
await row.save();
|
|
84
|
+
tombstoned += 1;
|
|
85
|
+
}
|
|
86
|
+
return tombstoned;
|
|
87
|
+
};
|
|
88
|
+
const fanOutComms = async ({ body, input, preferences, title, user, }) => {
|
|
89
|
+
const getComms = options.getComms;
|
|
90
|
+
if (!getComms) {
|
|
91
|
+
return;
|
|
92
|
+
}
|
|
93
|
+
try {
|
|
94
|
+
const comms = getComms();
|
|
95
|
+
if (preferences.mail && user?.email) {
|
|
96
|
+
try {
|
|
97
|
+
await comms.sendMail({
|
|
98
|
+
html: `<p>${escapeHtml(body)}</p>`,
|
|
99
|
+
subject: title,
|
|
100
|
+
text: body,
|
|
101
|
+
to: user.email,
|
|
102
|
+
}, { userId: input.userId });
|
|
103
|
+
}
|
|
104
|
+
catch (error) {
|
|
105
|
+
logger_1.logger.error("[notifications] comms fan-out channel failed after inbox write", {
|
|
106
|
+
channel: "mail",
|
|
107
|
+
error,
|
|
108
|
+
userId: input.userId,
|
|
109
|
+
});
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
if (preferences.sms && user?.phone) {
|
|
113
|
+
try {
|
|
114
|
+
await comms.sendSms({ body: `${title}: ${body}`, to: user.phone }, { userId: input.userId });
|
|
115
|
+
}
|
|
116
|
+
catch (error) {
|
|
117
|
+
logger_1.logger.error("[notifications] comms fan-out channel failed after inbox write", {
|
|
118
|
+
channel: "sms",
|
|
119
|
+
error,
|
|
120
|
+
userId: input.userId,
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
if (preferences.push) {
|
|
125
|
+
try {
|
|
126
|
+
await comms.sendPushToUser({
|
|
127
|
+
body,
|
|
128
|
+
title,
|
|
129
|
+
userId: input.userId,
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
catch (error) {
|
|
133
|
+
logger_1.logger.error("[notifications] comms fan-out channel failed after inbox write", {
|
|
134
|
+
channel: "push",
|
|
135
|
+
error,
|
|
136
|
+
userId: input.userId,
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
catch (error) {
|
|
142
|
+
logger_1.logger.error("[notifications] comms fan-out failed after inbox write", {
|
|
143
|
+
error,
|
|
144
|
+
userId: input.userId,
|
|
145
|
+
});
|
|
146
|
+
}
|
|
147
|
+
};
|
|
148
|
+
const notify = async (input) => {
|
|
149
|
+
const preferences = await loadPreferences(input.userId);
|
|
150
|
+
const user = await loadUser(options.userModel, input.userId);
|
|
151
|
+
let notificationId;
|
|
152
|
+
if (preferences.inapp) {
|
|
153
|
+
const row = await notification_1.Notification.create({
|
|
154
|
+
body: input.body,
|
|
155
|
+
href: input.href,
|
|
156
|
+
kind: input.kind,
|
|
157
|
+
ownerId: input.userId,
|
|
158
|
+
title: input.title,
|
|
159
|
+
});
|
|
160
|
+
notificationId = String(row._id);
|
|
161
|
+
}
|
|
162
|
+
await fanOutComms({
|
|
163
|
+
body: input.body,
|
|
164
|
+
input,
|
|
165
|
+
preferences,
|
|
166
|
+
title: input.title,
|
|
167
|
+
user,
|
|
168
|
+
});
|
|
169
|
+
if (retainDays > 0) {
|
|
170
|
+
await sweepExpired();
|
|
171
|
+
}
|
|
172
|
+
return notificationId ?? "";
|
|
173
|
+
};
|
|
174
|
+
return { notify, sweepExpired };
|
|
175
|
+
};
|
|
176
|
+
exports.createNotificationService = createNotificationService;
|
|
177
|
+
let notificationService = (0, exports.createNotificationService)();
|
|
178
|
+
const configureNotificationService = (options) => {
|
|
179
|
+
notificationService = (0, exports.createNotificationService)(options);
|
|
180
|
+
};
|
|
181
|
+
exports.configureNotificationService = configureNotificationService;
|
|
182
|
+
const getNotificationService = () => notificationService;
|
|
183
|
+
exports.getNotificationService = getNotificationService;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { Application } from "express";
|
|
2
|
+
import type { Model } from "mongoose";
|
|
3
|
+
import type { TerrenoPlugin } from "../terrenoPlugin";
|
|
4
|
+
import { type NotificationServiceOptions, type NotificationsCommsService } from "./notificationService";
|
|
5
|
+
export interface NotificationsAppOptions extends NotificationServiceOptions {
|
|
6
|
+
getComms?: () => NotificationsCommsService;
|
|
7
|
+
retainDays?: number;
|
|
8
|
+
userModel?: Model<{
|
|
9
|
+
email?: string;
|
|
10
|
+
phone?: string;
|
|
11
|
+
}>;
|
|
12
|
+
}
|
|
13
|
+
export declare class NotificationsApp implements TerrenoPlugin {
|
|
14
|
+
private readonly options;
|
|
15
|
+
private routers?;
|
|
16
|
+
constructor(options?: NotificationsAppOptions);
|
|
17
|
+
register(app: Application, openApi?: unknown): void;
|
|
18
|
+
}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NotificationsApp = void 0;
|
|
4
|
+
const luxon_1 = require("luxon");
|
|
5
|
+
const api_1 = require("../api");
|
|
6
|
+
const auth_1 = require("../auth");
|
|
7
|
+
const errors_1 = require("../errors");
|
|
8
|
+
const logger_1 = require("../logger");
|
|
9
|
+
const notification_1 = require("../models/notification");
|
|
10
|
+
const notificationPreference_1 = require("../models/notificationPreference");
|
|
11
|
+
const openApiBuilder_1 = require("../openApiBuilder");
|
|
12
|
+
const permissions_1 = require("../permissions");
|
|
13
|
+
const notificationService_1 = require("./notificationService");
|
|
14
|
+
const PREFERENCE_CHANNELS = ["inapp", "mail", "push", "sms"];
|
|
15
|
+
const parseNotificationDate = (value, fieldName) => {
|
|
16
|
+
if (value === null || value === undefined) {
|
|
17
|
+
return null;
|
|
18
|
+
}
|
|
19
|
+
if (value instanceof Date) {
|
|
20
|
+
return value;
|
|
21
|
+
}
|
|
22
|
+
if (typeof value === "string") {
|
|
23
|
+
const parsed = luxon_1.DateTime.fromISO(value);
|
|
24
|
+
if (!parsed.isValid) {
|
|
25
|
+
throw new errors_1.APIError({ status: 400, title: `${fieldName} must be a date or null` });
|
|
26
|
+
}
|
|
27
|
+
return parsed.toJSDate();
|
|
28
|
+
}
|
|
29
|
+
throw new errors_1.APIError({ status: 400, title: `${fieldName} must be a date or null` });
|
|
30
|
+
};
|
|
31
|
+
const sanitizeNotificationUpdate = (body) => {
|
|
32
|
+
const payload = body;
|
|
33
|
+
const update = {};
|
|
34
|
+
if (payload.readAt !== undefined) {
|
|
35
|
+
(0, notificationService_1.assertValidNotificationReadAt)(payload.readAt);
|
|
36
|
+
update.readAt = parseNotificationDate(payload.readAt, "readAt");
|
|
37
|
+
}
|
|
38
|
+
if (payload.archivedAt !== undefined) {
|
|
39
|
+
(0, notificationService_1.assertValidNotificationArchivedAt)(payload.archivedAt);
|
|
40
|
+
update.archivedAt = parseNotificationDate(payload.archivedAt, "archivedAt");
|
|
41
|
+
}
|
|
42
|
+
return update;
|
|
43
|
+
};
|
|
44
|
+
const sanitizePreferenceUpdate = (body) => {
|
|
45
|
+
const payload = body;
|
|
46
|
+
const update = {};
|
|
47
|
+
for (const channel of PREFERENCE_CHANNELS) {
|
|
48
|
+
if (channel in payload) {
|
|
49
|
+
update[channel] = payload[channel];
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return update;
|
|
53
|
+
};
|
|
54
|
+
class NotificationsApp {
|
|
55
|
+
options;
|
|
56
|
+
routers;
|
|
57
|
+
constructor(options = {}) {
|
|
58
|
+
this.options = options;
|
|
59
|
+
}
|
|
60
|
+
register(app, openApi) {
|
|
61
|
+
(0, notificationService_1.configureNotificationService)({
|
|
62
|
+
getComms: this.options.getComms,
|
|
63
|
+
retainDays: this.options.retainDays,
|
|
64
|
+
userModel: this.options.userModel,
|
|
65
|
+
});
|
|
66
|
+
if (this.routers) {
|
|
67
|
+
for (const router of this.routers) {
|
|
68
|
+
app.use(router.path, router.router);
|
|
69
|
+
}
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
const openApiMiddleware = openApi;
|
|
73
|
+
const sharedRouterOptions = openApiMiddleware
|
|
74
|
+
? { openApi: openApiMiddleware }
|
|
75
|
+
: {};
|
|
76
|
+
const notificationsRouter = (0, api_1.modelRouter)("/notifications", notification_1.Notification, {
|
|
77
|
+
...sharedRouterOptions,
|
|
78
|
+
endpoints: (router) => {
|
|
79
|
+
router.post("/mark-all-read", [
|
|
80
|
+
(0, auth_1.authenticateMiddleware)(),
|
|
81
|
+
(0, openApiBuilder_1.createOpenApiBuilder)(sharedRouterOptions)
|
|
82
|
+
.withTags(["notifications"])
|
|
83
|
+
.withSummary("Mark all of the caller's unread notifications as read")
|
|
84
|
+
.withResponse(200, {
|
|
85
|
+
data: {
|
|
86
|
+
properties: { modified: { type: "number" } },
|
|
87
|
+
type: "object",
|
|
88
|
+
},
|
|
89
|
+
})
|
|
90
|
+
.build(),
|
|
91
|
+
], (0, api_1.asyncHandler)(async (req, res) => {
|
|
92
|
+
const user = req.user;
|
|
93
|
+
if (!user?.id) {
|
|
94
|
+
throw new errors_1.APIError({ status: 401, title: "Authentication required" });
|
|
95
|
+
}
|
|
96
|
+
const unread = await notification_1.Notification.find({
|
|
97
|
+
$or: [{ readAt: null }, { readAt: { $exists: false } }],
|
|
98
|
+
ownerId: user.id,
|
|
99
|
+
});
|
|
100
|
+
const now = luxon_1.DateTime.now().toJSDate();
|
|
101
|
+
let modified = 0;
|
|
102
|
+
for (const row of unread) {
|
|
103
|
+
row.readAt = now;
|
|
104
|
+
await row.save();
|
|
105
|
+
modified += 1;
|
|
106
|
+
}
|
|
107
|
+
logger_1.logger.info("[notifications] mark-all-read", { modified, userId: user.id });
|
|
108
|
+
return res.json({ data: { modified } });
|
|
109
|
+
}));
|
|
110
|
+
},
|
|
111
|
+
permissions: {
|
|
112
|
+
create: [],
|
|
113
|
+
delete: [permissions_1.Permissions.IsOwner],
|
|
114
|
+
list: [permissions_1.Permissions.IsAuthenticated],
|
|
115
|
+
read: [permissions_1.Permissions.IsOwner],
|
|
116
|
+
update: [permissions_1.Permissions.IsOwner],
|
|
117
|
+
},
|
|
118
|
+
preUpdate: sanitizeNotificationUpdate,
|
|
119
|
+
queryFields: ["_id", "ownerId", "readAt", "archivedAt", "kind"],
|
|
120
|
+
queryFilter: permissions_1.OwnerQueryFilter,
|
|
121
|
+
sort: "-created",
|
|
122
|
+
sync: { scope: { type: "owner" } },
|
|
123
|
+
});
|
|
124
|
+
app.use(notificationsRouter.path, notificationsRouter.router);
|
|
125
|
+
const preferencesRouter = (0, api_1.modelRouter)("/notification-preferences", notificationPreference_1.NotificationPreference, {
|
|
126
|
+
...(openApiMiddleware ? { openApi: openApiMiddleware } : {}),
|
|
127
|
+
permissions: {
|
|
128
|
+
create: [permissions_1.Permissions.IsAuthenticated],
|
|
129
|
+
delete: [permissions_1.Permissions.IsOwner],
|
|
130
|
+
list: [permissions_1.Permissions.IsAuthenticated],
|
|
131
|
+
read: [permissions_1.Permissions.IsOwner],
|
|
132
|
+
update: [permissions_1.Permissions.IsOwner],
|
|
133
|
+
},
|
|
134
|
+
preCreate: (body, req) => {
|
|
135
|
+
const user = req.user;
|
|
136
|
+
if (!user?.id) {
|
|
137
|
+
throw new errors_1.APIError({ status: 401, title: "Authentication required" });
|
|
138
|
+
}
|
|
139
|
+
const payload = body;
|
|
140
|
+
return {
|
|
141
|
+
...payload,
|
|
142
|
+
ownerId: user.id,
|
|
143
|
+
};
|
|
144
|
+
},
|
|
145
|
+
preUpdate: sanitizePreferenceUpdate,
|
|
146
|
+
queryFields: ["ownerId"],
|
|
147
|
+
queryFilter: permissions_1.OwnerQueryFilter,
|
|
148
|
+
sort: "-created",
|
|
149
|
+
sync: { scope: { type: "owner" } },
|
|
150
|
+
});
|
|
151
|
+
app.use(preferencesRouter.path, preferencesRouter.router);
|
|
152
|
+
this.routers = [notificationsRouter, preferencesRouter];
|
|
153
|
+
logger_1.logger.info("NotificationsApp registered", { retainDays: this.options.retainDays ?? 0 });
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
exports.NotificationsApp = NotificationsApp;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export type NotificationsBeforeSendChannel = "mail" | "push" | "sms" | "verification";
|
|
2
|
+
export interface NotificationsBeforeSendContext {
|
|
3
|
+
channel: NotificationsBeforeSendChannel;
|
|
4
|
+
userId?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface NotificationsBeforeSendResult {
|
|
7
|
+
cancel?: boolean;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
|
|
11
|
+
* disabled that channel in NotificationPreference. Missing preference rows default to
|
|
12
|
+
* all channels on. The `verification` channel is never cancelled here.
|
|
13
|
+
*/
|
|
14
|
+
export declare const notificationsBeforeSend: ({ channel, userId, }: NotificationsBeforeSendContext) => Promise<NotificationsBeforeSendResult | undefined>;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.notificationsBeforeSend = void 0;
|
|
4
|
+
const notificationPreference_1 = require("../models/notificationPreference");
|
|
5
|
+
const PREFERENCE_FIELD_BY_CHANNEL = {
|
|
6
|
+
mail: "mail",
|
|
7
|
+
push: "push",
|
|
8
|
+
sms: "sms",
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
|
|
12
|
+
* disabled that channel in NotificationPreference. Missing preference rows default to
|
|
13
|
+
* all channels on. The `verification` channel is never cancelled here.
|
|
14
|
+
*/
|
|
15
|
+
const notificationsBeforeSend = async ({ channel, userId, }) => {
|
|
16
|
+
if (channel === "verification" || !userId) {
|
|
17
|
+
return undefined;
|
|
18
|
+
}
|
|
19
|
+
const preferenceField = PREFERENCE_FIELD_BY_CHANNEL[channel];
|
|
20
|
+
if (!preferenceField) {
|
|
21
|
+
return undefined;
|
|
22
|
+
}
|
|
23
|
+
const preference = await notificationPreference_1.NotificationPreference.findOneOrNone({ ownerId: userId });
|
|
24
|
+
if (!preference) {
|
|
25
|
+
return undefined;
|
|
26
|
+
}
|
|
27
|
+
if (preference[preferenceField] === false) {
|
|
28
|
+
return { cancel: true };
|
|
29
|
+
}
|
|
30
|
+
return undefined;
|
|
31
|
+
};
|
|
32
|
+
exports.notificationsBeforeSend = notificationsBeforeSend;
|