@whooshbang/contract-mock 1.0.0-rc.30 → 1.0.0-rc.32

package/CHANGELOG.md

@@ -5,6 +5,24 @@ recorded here.
 
 ## Unreleased
 
+## 1.0.0-rc.32
+
+- Serve the project and environment recipient-experience routes, and the
+  recipient-copy override routes, to a project credential carrying
+  `projects:read` / `projects:write` as well as to a human session and a grant.
+  The environment pair previously accepted only a session, so an integrator
+  journey run against the mock could not configure the project it was
+  integrating any more than the real service could.
+- Reissue the mock against `@whooshbang/contracts@1.0.0-rc.20` and
+  `@whooshbang/sdk@1.0.0-rc.29`.
+
+## 1.0.0-rc.31
+
+- Default an unconfigured recipient experience to the canonical WhooshBang red
+  while continuing to preserve configured customer accent colours.
+- Reissue the mock against `@whooshbang/contracts@1.0.0-rc.19` and
+  `@whooshbang/sdk@1.0.0-rc.28` for the WhooshBang-owned recipient attribution.
+
 ## 1.0.0-rc.30
 
 - Add normalized recipient-logo upload, atomic replacement, session-authorized

package/dist/core.js

@@ -1,8 +1,8 @@
 import { Hono } from "hono";
-import { canonicalIanaTimeZone, classifyWebhookDeliveryOutcome, isCustomizableRecipientCopyKey, recipientCopyOverrideIssues, RECIPIENT_BRAND_LOGO_MAX_INPUT_BYTES, RecipientBrandLogoError, normalizeRecipientBrandLogo, NOTIFICATION_IMAGE_MAX_BYTES, NotificationImageError, normalizeNotificationImage, contractValidationErrors, MAX_WEBHOOK_DELIVERY_ATTEMPTS, validateAccountProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAttachNotifierConnectionRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateCreateGroupBroadcastRequest, validateCreateApiCredentialRequest, validateCreateChannelConnectionRequest, validateCreateCustomerEndpointRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCreateProjectRequest, validateCreateProviderHandoffRequest, validateCreateRecipientGroupRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateCreateSubscriberRequest, validateCreateSubscriptionLinkRequest, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateInteractionEvent, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateNotifierConnectionCollection, validateWhooshBangEvent, validateProblem, validateProject, validateProjectCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateEnvironmentRecipientExperience, validateGroupBroadcast, validatePreferredBinding, validateProviderHandoff, validateRecipientGroup, validateRecipientGroupCollection, validateRecipientGroupMembership, validateRecipientGroupMembershipCollection, validateRecipientHandoffCompletion, validateRecipientCopyOverrideCollection, validateRecipientCopyOverride, validateRecipientSession, validateSetPreferredBindingRequest, validateSubscriber, validateProviderCapabilitiesCollection, validateRegisterMachineCredentialRequest, validateRotateApiCredentialRequest, validateRotateChannelConnectionCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionLink, validateUpdateChannelConnectionRequest, validateUpdateEnvironmentRecipientExperienceRequest, validateUpdateProjectRecipientExperienceRequest, validateUpdateRecipientCopyOverrideRequest, validateUpdateRecipientGroupRequest, verifyMachineCredentialToken, } from "@whooshbang/contracts";
+import { canonicalIanaTimeZone, classifyWebhookDeliveryOutcome, isCustomizableRecipientCopyKey, recipientCopyOverrideIssues, RECIPIENT_BRAND_DEFAULT_ACCENT_COLOR, RECIPIENT_BRAND_LOGO_MAX_INPUT_BYTES, RecipientBrandLogoError, normalizeRecipientBrandLogo, NOTIFICATION_IMAGE_MAX_BYTES, NotificationImageError, normalizeNotificationImage, contractValidationErrors, MAX_WEBHOOK_DELIVERY_ATTEMPTS, validateAccountProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAttachNotifierConnectionRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateCreateGroupBroadcastRequest, validateCreateApiCredentialRequest, validateCreateChannelConnectionRequest, validateCreateCustomerEndpointRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCreateProjectRequest, validateCreateProviderHandoffRequest, validateCreateRecipientGroupRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateCreateSubscriberRequest, validateCreateSubscriptionLinkRequest, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateInteractionEvent, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateNotifierConnectionCollection, validateWhooshBangEvent, validateProblem, validateProject, validateProjectCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateEnvironmentRecipientExperience, validateGroupBroadcast, validatePreferredBinding, validateProviderHandoff, validateRecipientGroup, validateRecipientGroupCollection, validateRecipientGroupMembership, validateRecipientGroupMembershipCollection, validateRecipientHandoffCompletion, validateRecipientCopyOverrideCollection, validateRecipientCopyOverride, validateRecipientSession, validateSetPreferredBindingRequest, validateSubscriber, validateProviderCapabilitiesCollection, validateRegisterMachineCredentialRequest, validateRotateApiCredentialRequest, validateRotateChannelConnectionCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionLink, validateUpdateChannelConnectionRequest, validateUpdateEnvironmentRecipientExperienceRequest, validateUpdateProjectRecipientExperienceRequest, validateUpdateRecipientCopyOverrideRequest, validateUpdateRecipientGroupRequest, verifyMachineCredentialToken, } from "@whooshbang/contracts";
 import { getScenarioDefinition } from "./scenarios.js";
 import { parseInteractionControlInput } from "./interaction-control.js";
-const CONTRACT_VERSION = "1.0.0-rc.18";
+const CONTRACT_VERSION = "1.0.0-rc.20";
 const SCENARIO_VERSION = "contract-mock-scenarios.v1";
 const MAX_REQUEST_BYTES = 64 * 1024;
 const MAX_PROVIDER_ATTEMPTS = 8;
@@ -146,7 +146,7 @@ const RECIPIENT_COPY_MAXIMUM_LENGTH_BY_KEY = {
 function defaultProjectRecipientExperience(state, project) {
     return {
         brand: {
-            accent_color: "#4F46E5",
+            accent_color: RECIPIENT_BRAND_DEFAULT_ACCENT_COLOR,
             color_scheme: "system",
             display_name: project.name,
         },
@@ -1256,8 +1256,13 @@ function authenticate(request, state, acceptedKind) {
         (acceptedKind === "account" &&
             credential.kind !== "human" &&
             credential.kind !== "grant") ||
+        (acceptedKind === "configuration" &&
+            credential.kind !== "human" &&
+            credential.kind !== "grant" &&
+            credential.kind !== "project") ||
         (acceptedKind !== "either" &&
             acceptedKind !== "account" &&
+            acceptedKind !== "configuration" &&
             credential.kind !== acceptedKind)) {
         return {
             response: problemResponse(problem("credential_invalid", 401, state.idGenerator("diagnostic"))),
@@ -1294,6 +1299,41 @@ function requireHumanSession(request, state) {
  * A project credential is refused structurally rather than by a scope check —
  * it has no account-level scope to hold, because it lives inside one project.
  */
+/**
+ * The authority that may read or write one project's configuration.
+ *
+ * A person and a grant name the whole account, so the project is checked
+ * against their membership. A project credential names exactly one project, so
+ * a path naming another is answered the way a project that does not exist is
+ * answered — a credential must not be able to map the account it lives in.
+ *
+ * This used to be a human session alone, which meant an application holding a
+ * credential could not configure the project it was integrating (FXO-2150).
+ */
+function requireConfigurationAuthority(request, state, projectId, scope) {
+    const result = authenticate(request, state, "configuration");
+    if (isAuthFailure(result)) {
+        return result;
+    }
+    const credential = result.credential;
+    if (credential.kind === "human") {
+        return { credential, requestId: result.requestId };
+    }
+    if (credential.kind !== "grant" && credential.kind !== "project") {
+        return {
+            response: problemResponse(problem("credential_invalid", 401, state.idGenerator("diagnostic"))),
+        };
+    }
+    if (!credential.scopes.includes(scope)) {
+        return {
+            response: problemResponse(problem("scope_forbidden", 403, state.idGenerator("diagnostic"))),
+        };
+    }
+    if (credential.kind === "project" && credential.projectId !== projectId) {
+        return { response: notFound(state) };
+    }
+    return { credential, requestId: result.requestId };
+}
 function requireAccountAuthority(request, state, scope) {
     const result = authenticate(request, state, "account");
     if (isAuthFailure(result)) {
@@ -3386,7 +3426,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.get("/v1/projects/:projectId/recipient-copy-overrides", (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:read");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:read");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3425,7 +3465,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.put("/v1/projects/:projectId/recipient-copy-overrides/:language/:copyKey", async (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:write");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:write");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3465,7 +3505,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.delete("/v1/projects/:projectId/recipient-copy-overrides/:language/:copyKey", (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:write");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:write");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3488,7 +3528,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.get("/v1/projects/:projectId/recipient-experience", (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:read");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:read");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3506,7 +3546,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.put("/v1/projects/:projectId/recipient-experience", async (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:write");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:write");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3559,7 +3599,7 @@ function addPublicRoutes(app, getState, options) {
     });
     app.put("/v1/projects/:projectId/recipient-experience/logo", async (context) => {
         const state = getState();
-        const identity = requireAccountAuthority(context.req.raw, state, "projects:write");
+        const identity = requireConfigurationAuthority(context.req.raw, state, context.req.param("projectId"), "projects:write");
         if (isAuthFailure(identity))
             return identity.response;
         const projectId = context.req.param("projectId");
@@ -3627,10 +3667,10 @@ function addPublicRoutes(app, getState, options) {
     });
     app.get("/v1/projects/:projectId/environments/:environmentId/recipient-experience", (context) => {
         const state = getState();
-        const identity = requireHumanSession(context.req.raw, state);
+        const projectId = context.req.param("projectId");
+        const identity = requireConfigurationAuthority(context.req.raw, state, projectId, "projects:read");
         if (isAuthFailure(identity))
             return identity.response;
-        const projectId = context.req.param("projectId");
         const environment = projectEnvironmentForHuman(state, identity, projectId, context.req.param("environmentId"));
         const experience = environment === undefined
             ? undefined
@@ -3645,10 +3685,10 @@ function addPublicRoutes(app, getState, options) {
     });
     app.put("/v1/projects/:projectId/environments/:environmentId/recipient-experience", async (context) => {
         const state = getState();
-        const identity = requireHumanSession(context.req.raw, state);
+        const projectId = context.req.param("projectId");
+        const identity = requireConfigurationAuthority(context.req.raw, state, projectId, "projects:write");
         if (isAuthFailure(identity))
             return identity.response;
-        const projectId = context.req.param("projectId");
         const environment = projectEnvironmentForHuman(state, identity, projectId, context.req.param("environmentId"));
         const key = environment === undefined
             ? undefined