@whooshbang/contracts 1.0.0-rc.22 → 1.0.0-rc.24

package/CHANGELOG.md

@@ -4,6 +4,74 @@ All notable contract changes are recorded here.
 
 ## Unreleased
 
+## 1.0.0-rc.24
+
+### Breaking
+
+- The channel-connection surface no longer names Slack (FXO-2442). Rename
+  `CustomerOwnedSlackChannelConnection`, `CustomerOwnedSlackConnectionSetup`,
+  `CustomerOwnedSlackSetupStatus`, `CustomerOwnedSlackAppAuthority` and
+  `CustomerOwnedSlackAppManifest` to `CustomerApplicationChannelConnection`,
+  `CustomerApplicationConnectionSetup`, `CustomerApplicationSetupStatus`,
+  `CustomerApplicationAuthority` and `CustomerApplicationManifest`, and
+  `validateCustomerOwnedSlackAppManifest` to
+  `validateCustomerApplicationManifest`. The old names have no aliases.
+- The application authorities a customer-owned application hands over are
+  `application_identity`, `application_secret` and `ingress_secret`, replacing
+  `client_identity`, `client_secret` and `signing_secret` on
+  `RotateChannelConnectionCredentialRequest` and in `outstanding_authorities`.
+  `ingress_secret` is optional in shape; a provider whose application has one
+  (Slack) still refuses a request without it. `application_identity` is bounded
+  printable text; Slack still refuses a Client ID that is not
+  `<digits>.<digits>`.
+- `TelegramConnectionIdentity`, `SlackConnectionIdentity` and
+  `EmailConnectionIdentity` are one `ConnectionIdentity` whose `provider` is any
+  `ChannelConnectionProvider`; an email handle is still an `EmailAddress`, and
+  every other handle is still at most 128 characters.
+  `SubscriptionConnectionSummary` is one object rather than a union of three.
+- `HostedChannelConnection`, `CustomerApplicationChannelConnection` and the
+  hosted and customer-application arms of `CreateChannelConnectionRequest` take
+  any `ChannelConnectionProvider` rather than the `slack` constant. A provider
+  without that setup refuses it as `request_invalid` with the
+  `setup_mode_unavailable` field error on `/mode`.
+  `provider` alone therefore no longer discriminates `ChannelConnection`:
+  narrow on `mode`, or on a field only that arm publishes.
+- `management_url` is no longer pinned to `slack://app`, and `creation_url` is
+  no longer pinned to `https://api.slack.com/apps`; each is a provider-owned
+  link. `management_url` still refuses a scheme a browser would execute.
+- `CustomerApplicationManifest` carries `provider`; each of its `request_urls`
+  is present only when the provider calls it separately, and `manifest` only
+  when the provider creates the application from a document. Slack's always
+  carries all of them.
+- `OrganizationClosureProviderAction.provider` is any
+  `ChannelConnectionProvider` rather than `telegram` or `slack`.
+
+### Added
+
+- `ProblemCode` gains `internal_error` (500, "Internal error", retryable): a
+  fault inside WhooshBang with no provider or customer system involved. It
+  replaces the `provider_retryable` 503 the service used to answer for any
+  unrecognised failure, which sent readers to check a provider that was
+  working (FXO-2612). A consumer that switches exhaustively on `ProblemCode`
+  needs a branch for it.
+
+## 1.0.0-rc.23
+
+### Breaking
+
+- Rename the WhooshBang tenant to organization throughout the public contract
+  (FXO-2337): `OrganizationProjection`, membership, role, credential and closure
+  types, `/v1/organization` routes, `organization_id` fields and
+  `organization:read`. Former tenant names have no aliases or deprecation
+  window. Personal and provider accounts retain their meaning.
+- Organization credentials use `wb_oc1` and `ocred_`. The deployment migration
+  revokes existing tenant credentials; issue fresh organization credentials and
+  reauthorize existing OAuth clients after the cut. Project and machine
+  credentials retain their kinds.
+- Update schemas, generated validators and synthetic fixtures together.
+  Integrators must update SDK validators even when their application does not
+  explicitly read the renamed tenant field.
+
 ## 1.0.0-rc.22
 
 - FXO-2271: live sends reject the reserved `test:` subscriber prefix and explicit

package/README.md

@@ -1,5 +1,11 @@
 # WhooshBang contract workspace
 
+The organization contract batch uses `@whooshbang/contracts@1.0.0-rc.23`,
+`@whooshbang/sdk@1.0.0-rc.32` and `@whooshbang/contract-mock@1.0.0-rc.35`.
+Install the matching batch after publication. FXO-2337 is a clean cut from
+tenant account terminology; the [upgrade guide](../../docs/onboarding/organization-upgrade.mdx)
+covers renamed types, routes, fields, credentials and integration validation.
+
 `@whooshbang/contracts` is the runtime-neutral artifact boundary for
 public contracts owned by WhooshBang. It does not depend on sibling
 repositories or Cloudflare runtime types.
@@ -21,7 +27,7 @@ npm install @whooshbang/contracts@next
   pinned and exchanged as tarballs rather than accessed through sibling paths.
 
 The manifest indexes the C0-02 core REST contract, its approved N1-02
-account/project administration and N1-03 credential-lifecycle amendments, the
+organization/project administration and N1-03 credential-lifecycle amendments, the
 C0-03 interaction, machine-client, machine-event, and provider-capability
 contracts, and the C0-04 signed customer-event and delivery contracts. The
 canonical API is `openapi/whooshbang-v1.yaml`; its committed distribution
@@ -38,8 +44,8 @@ perform no networking or persistence.
 
 ## N1-03 credential boundary
 
-- Human credential administration is scoped by the verified Clerk account and
-  explicit account-owned project/environment path targets.
+- Human credential administration is scoped by the verified Clerk organization and
+  explicit organization-owned project/environment path targets.
 - Project bearer syntax is
   `wb_pc1.pcred_<16-byte-base64url>.<32-byte-base64url-secret>`. Creation and
   rotation reveal the complete bearer exactly once and cannot be replayed.

package/contract-manifest.json

@@ -1,120 +1,120 @@
 {
   "schema": "flowxo.contract-manifest.v1",
   "artifact": "@whooshbang/contracts",
-  "version": "1.0.0-rc.22",
+  "version": "1.0.0-rc.24",
   "openapi": [
     {
       "id": "whooshbang-rest-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "openapi/whooshbang-v1.yaml"
     }
   ],
   "schemas": [
     {
       "id": "whooshbang-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/whooshbang-v1.schema.json"
     },
     {
       "id": "interaction-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/interaction-v1.schema.json"
     },
     {
       "id": "machine-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/machine-v1.schema.json"
     },
     {
       "id": "provider-capabilities-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/provider-capabilities-v1.schema.json"
     },
     {
       "id": "whooshbang-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/whooshbang-event-v1.schema.json"
     },
     {
       "id": "subscription-activated-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/subscription-activated-v1.schema.json"
     },
     {
       "id": "subscription-revoked-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/subscription-revoked-v1.schema.json"
     },
     {
       "id": "message-provider-accepted-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/message-provider-accepted-v1.schema.json"
     },
     {
       "id": "message-delivered-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/message-delivered-v1.schema.json"
     },
     {
       "id": "message-failed-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/message-failed-v1.schema.json"
     },
     {
       "id": "message-expired-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/message-expired-v1.schema.json"
     },
     {
       "id": "interaction-received-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/interaction-received-v1.schema.json"
     },
     {
       "id": "interaction-expired-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/interaction-expired-v1.schema.json"
     },
     {
       "id": "agent-binding-degraded-event-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/events/agent-binding-degraded-v1.schema.json"
     },
     {
       "id": "webhook-signing-vector-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/webhooks/webhook-signing-vector-v1.schema.json"
     },
     {
       "id": "webhook-delivery-case-v1",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/webhooks/webhook-delivery-case-v1.schema.json"
     },
     {
       "id": "interaction-machine-scenario",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/interaction-machine-scenario.schema.json"
     },
     {
       "id": "core-contract-scenario",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/core-scenario.schema.json"
     },
     {
       "id": "core-fixture-index",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "path": "schemas/fixture-index.schema.json"
     }
   ],
   "fixture_sets": [
     {
       "id": "core-api-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/whooshbang-v1.schema.json",
       "fixtures": [
         "fixtures/core-v1/requests/create-project.json",
         "fixtures/core-v1/requests/update-project.json",
-        "fixtures/core-v1/success/account-projection.json",
+        "fixtures/core-v1/success/organization-projection.json",
         "fixtures/core-v1/success/project-created.json",
         "fixtures/core-v1/success/project-collection.json",
         "fixtures/core-v1/requests/create-api-credential.json",
@@ -123,13 +123,13 @@
         "fixtures/core-v1/success/api-credential-created.json",
         "fixtures/core-v1/success/api-credential-rotated.json",
         "fixtures/core-v1/success/api-credential-revoked.json",
-        "fixtures/core-v1/requests/create-account-credential.json",
-        "fixtures/core-v1/requests/rotate-account-credential.json",
-        "fixtures/core-v1/success/account-credential-collection.json",
-        "fixtures/core-v1/success/account-credential-created.json",
-        "fixtures/core-v1/success/account-credential-rotated.json",
-        "fixtures/core-v1/success/account-credential-revoked.json",
-        "fixtures/core-v1/problems/credential-account-mismatch.json",
+        "fixtures/core-v1/requests/create-organization-credential.json",
+        "fixtures/core-v1/requests/rotate-organization-credential.json",
+        "fixtures/core-v1/success/organization-credential-collection.json",
+        "fixtures/core-v1/success/organization-credential-created.json",
+        "fixtures/core-v1/success/organization-credential-rotated.json",
+        "fixtures/core-v1/success/organization-credential-revoked.json",
+        "fixtures/core-v1/problems/credential-organization-mismatch.json",
         "fixtures/core-v1/requests/create-customer-endpoint.json",
         "fixtures/core-v1/requests/rotate-customer-endpoint.json",
         "fixtures/core-v1/success/customer-endpoint-created.json",
@@ -138,12 +138,14 @@
         "fixtures/core-v1/success/customer-endpoint-collection.json",
         "fixtures/core-v1/success/customer-endpoint-attempts.json",
         "fixtures/core-v1/requests/create-subscription-link.json",
+        "fixtures/core-v1/requests/create-subscription-link-email.json",
         "fixtures/core-v1/requests/create-message.json",
         "fixtures/core-v1/requests/create-message-structured.json",
         "fixtures/core-v1/requests/create-message-image.json",
         "fixtures/core-v1/requests/create-message-document-image.json",
         "fixtures/core-v1/requests/create-message-connection.json",
         "fixtures/core-v1/success/subscription-link-pending.json",
+        "fixtures/core-v1/success/subscription-link-email-pending.json",
         "fixtures/core-v1/success/subscription-link-activated.json",
         "fixtures/core-v1/success/subscription-link-paused.json",
         "fixtures/core-v1/success/subscription-link-revoked.json",
@@ -174,7 +176,10 @@
         "fixtures/core-v1/problems/rate-limited.json",
         "fixtures/core-v1/problems/provider-retryable.json",
         "fixtures/core-v1/problems/provider-terminal.json",
+        "fixtures/core-v1/problems/provider-destination-suppressed.json",
+        "fixtures/core-v1/problems/provider-hard-bounce.json",
         "fixtures/core-v1/problems/provider-outcome-unknown.json",
+        "fixtures/core-v1/problems/internal-error.json",
         "fixtures/core-v1/requests/create-channel-connection.json",
         "fixtures/core-v1/requests/create-channel-connection-byok.json",
         "fixtures/core-v1/requests/create-channel-connection-managed.json",
@@ -190,6 +195,14 @@
         "fixtures/core-v1/success/channel-connection-managed-setup-failed.json",
         "fixtures/core-v1/success/channel-connection-slack-hosted-pending.json",
         "fixtures/core-v1/success/channel-connection-slack-hosted-active.json",
+        "fixtures/core-v1/success/channel-connection-email-shared.json",
+        "fixtures/core-v1/success/channel-connection-email-customer.json",
+        "fixtures/core-v1/success/channel-connection-email-customer-test.json",
+        "fixtures/core-v1/success/provider-installation-email-collection.json",
+        "fixtures/core-v1/success/email-domain-collection.json",
+        "fixtures/core-v1/requests/create-email-domain.json",
+        "fixtures/core-v1/requests/create-email-binding-import.json",
+        "fixtures/core-v1/success/email-binding-import-job.json",
         "fixtures/core-v1/success/channel-connection-slack-hosted-failed.json",
         "fixtures/core-v1/success/channel-connection-slack-customer-pending.json",
         "fixtures/core-v1/success/channel-connection-slack-customer-active.json",
@@ -237,17 +250,19 @@
         "fixtures/recipient-experience-v1/success/recipient-group-members.json",
         "fixtures/recipient-experience-v1/success/group-broadcast-accepted.json",
         "fixtures/recipient-experience-v1/success/group-broadcast-complete.json",
-        "fixtures/recipient-experience-v1/success/broadcast-child-message.json"
+        "fixtures/recipient-experience-v1/success/broadcast-child-message.json",
+        "fixtures/core-v1/requests/assert-email-consent.json",
+        "fixtures/core-v1/success/email-consent-asserted.json"
       ]
     },
     {
       "id": "core-semantic-scenarios",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/core-scenario.schema.json",
       "fixtures": [
         "fixtures/core-v1/scenarios/project-create-equivalent-replay.json",
         "fixtures/core-v1/scenarios/project-slug-conflict.json",
-        "fixtures/core-v1/scenarios/cross-account-project.json",
+        "fixtures/core-v1/scenarios/cross-organization-project.json",
         "fixtures/core-v1/scenarios/api-credential-one-time-reveal.json",
         "fixtures/core-v1/scenarios/api-credential-rotation-overlap.json",
         "fixtures/core-v1/scenarios/api-credential-revocation-replay.json",
@@ -274,7 +289,7 @@
     },
     {
       "id": "interaction-message-api-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/whooshbang-v1.schema.json",
       "fixtures": [
         "fixtures/interaction-machine-v1/requests/create-message-confirm.json",
@@ -286,7 +301,7 @@
     },
     {
       "id": "interaction-contract-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/interaction-v1.schema.json",
       "fixtures": [
         "fixtures/interaction-machine-v1/success/interaction-open.json",
@@ -303,7 +318,7 @@
     },
     {
       "id": "machine-api-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/machine-v1.schema.json",
       "fixtures": [
         "fixtures/interaction-machine-v1/requests/create-machine-client.json",
@@ -324,13 +339,13 @@
     },
     {
       "id": "provider-capability-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/provider-capabilities-v1.schema.json",
       "fixtures": ["fixtures/interaction-machine-v1/capabilities/telegram.json"]
     },
     {
       "id": "interaction-machine-semantic-scenarios",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/interaction-machine-scenario.schema.json",
       "fixtures": [
         "fixtures/interaction-machine-v1/scenarios/interaction-duplicate.json",
@@ -367,7 +382,7 @@
     },
     {
       "id": "customer-event-bodies",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/events/whooshbang-event-v1.schema.json",
       "fixtures": [
         "fixtures/whooshbang-events-v1/events/subscription-activated.json",
@@ -378,24 +393,26 @@
         "fixtures/whooshbang-events-v1/events/message-expired.json",
         "fixtures/whooshbang-events-v1/events/interaction-received.json",
         "fixtures/whooshbang-events-v1/events/interaction-expired.json",
-        "fixtures/whooshbang-events-v1/events/agent-binding-degraded.json"
+        "fixtures/whooshbang-events-v1/events/agent-binding-degraded.json",
+        "fixtures/whooshbang-events-v1/events/subscription-asserted.json",
+        "fixtures/whooshbang-events-v1/events/subscription-asserted-revoked.json"
       ]
     },
     {
       "id": "webhook-signing-vectors",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/webhooks/webhook-signing-vector-v1.schema.json",
       "fixtures": ["fixtures/whooshbang-events-v1/signing/vectors.json"]
     },
     {
       "id": "webhook-delivery-cases",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/webhooks/webhook-delivery-case-v1.schema.json",
       "fixtures": ["fixtures/whooshbang-events-v1/delivery/cases.json"]
     },
     {
       "id": "core-fixture-index",
-      "version": "1.0.0-rc.22",
+      "version": "1.0.0-rc.24",
       "schema": "schemas/fixture-index.schema.json",
       "fixtures": ["fixtures/core-v1/fixture-index.json"]
     }