@crvouga/mockingbird-service-customerio 3.0.0 → 3.1.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/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Changelog — @crvouga/mockingbird-service-customerio
2
2
 
3
+ ## 3.1.0 (2026-10-08)
4
+
5
+ ### Features
6
+
7
+ - redesign emulator experience ([d6038c2](https://github.com/crvouga/mockingbird/commit/d6038c27eebbaa1751f02bc9305002a5b1304779))
8
+
9
+ ### Dependencies
10
+
11
+ - `@crvouga/mockingbird-service-sqlite`
12
+
3
13
  ## 3.0.0 (2026-10-07)
4
14
 
5
15
  ### ⚠️ Breaking changes
@@ -14,10 +24,6 @@
14
24
  - typecheck the brand gate before builds ([fc36095](https://github.com/crvouga/mockingbird/commit/fc3609514de70ffe3170a5d216fb8a49f9ce7cbb))
15
25
  - format the emulates records query ([8698872](https://github.com/crvouga/mockingbird/commit/8698872509d06002be5a8fcdc85d79f8462320c3))
16
26
 
17
- ### Dependencies
18
-
19
- - `@crvouga/mockingbird-service-sqlite`
20
-
21
27
  ## 2.3.0 (2026-10-04)
22
28
 
23
29
  ### Features
package/DISCOVERY.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # @crvouga/mockingbird-service-customerio discovery
2
2
 
3
3
  This is the installed-package index for coding agents and tooling. All relative links resolve
4
- inside `node_modules/@crvouga/mockingbird-service-customerio/`; no repository checkout is needed to discover the mock's
4
+ inside `node_modules/@crvouga/mockingbird-service-customerio/`; no repository checkout is needed to discover the emulator's
5
5
  supported surface or documented behavior.
6
6
 
7
7
  ## Capability and behavior sources
@@ -48,7 +48,7 @@ designed for assertions and diagnosis by consuming test suites.
48
48
  ## Report a mismatch or missing capability
49
49
 
50
50
  Follow the [agent reporting contract](https://github.com/crvouga/mockingbird/blob/main/docs/REPORTING_ISSUES.md). Include package version,
51
- operation/command, a minimal redacted request, actual mock result, expected oracle result or vendor
51
+ operation/command, a minimal redacted request, actual emulator result, expected oracle result or vendor
52
52
  documentation, and whether the mismatch appears in the matrix. Never include keys, tokens,
53
53
  customer data, prompts, PHI, card data, or unredacted recordings.
54
54
 
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # @crvouga/mockingbird-service-customerio
2
2
 
3
- > Familiar calls. Faithful echoes. Part of [Mockingbird](https://github.com/crvouga/mockingbird).
3
+ > Local emulators. Real API contracts. Part of [Mockingbird](https://github.com/crvouga/mockingbird).
4
4
 
5
- Stateful mock of **Customer.io** for test suites, serving all three hosts our code talks to from
5
+ Stateful emulator of **Customer.io** for test suites, serving all three hosts our code talks to from
6
6
  one process: the Segment-compatible **CDP** (`identify`, `track`, `batch`, exactly as
7
7
  `@customerio/cdp-analytics-node` posts them), the **App API** transactional sends (email, SMS,
8
8
  inbox message), message catalog, profile attribute reads, sender opt-out reconciliation, and delivery-status reads, and the
@@ -28,7 +28,7 @@ with any Fetch server.
28
28
 
29
29
  The app hardcodes Customer.io's hosts per region (`customer-io.config.ts`, seam G-Y1): once
30
30
  they are env-driven, point the CDP host (the SDK's `host`), the App API host and the link
31
- tracking domain at the mock. Customer.io only runs when `CUSTOMERIO_RUNTIME_ENABLED` is on and
31
+ tracking domain at the emulator. Customer.io only runs when `CUSTOMERIO_RUNTIME_ENABLED` is on and
32
32
  the stage is in `CUSTOMERIO_ALLOWED_STAGES`.
33
33
 
34
34
  ```bash
@@ -56,7 +56,7 @@ await fetch(`${cio.url}/__admin/reporting-events`, {
56
56
  })
57
57
  ```
58
58
 
59
- Without the SDK, drive the mock directly and read back what the app sent:
59
+ Without the SDK, drive the emulator directly and read back what the app sent:
60
60
 
61
61
  ```ts
62
62
  import { createServer } from "@crvouga/mockingbird-service-customerio/server"
@@ -122,7 +122,7 @@ Fault presets (`POST /__admin/faults {"preset": "<name>", "count"?: n}`; `GET /_
122
122
  the 10 s delivery timeout), `transactional_list_unavailable`, `omit_trigger_names` (omit every
123
123
  `trigger_name`, or only `params.ids`), `webhook_duplicate`, `webhook_drop`, `webhook_reorder`.
124
124
  A manual fault can inject 403 or 503, or a 429 whose `Retry-After` is an HTTP-date. ECONNREFUSED
125
- (a definite failure) is a stopped mock, not a preset. 401 is `{error}` on the CDP and
125
+ (a definite failure) is a stopped emulator, not a preset. 401 is `{error}` on the CDP and
126
126
  `{meta: {error}}` on the App API. Keys mapped to the same namespace share profiles and deliveries;
127
127
  two namespaces do not, including faults and clock offsets. Resetting one namespace leaves the other.
128
128
 
@@ -148,8 +148,8 @@ username) or the App API key (Bearer) through `PUT /__admin/credentials {"creden
148
148
 
149
149
  | Export | Kind | Description |
150
150
  | --- | --- | --- |
151
- | `CustomerIoAPI` | class | The in-process mock: `fetch(request)`, `reset()`, `report(input)`, `profiles()`, `mergeProfile(id, patch)`, `transitionDelivery(id, state)`, `advanceClock(ms)`, `state`. Options: `sqlite`, `now`, `wallClock`, `namespace`, `messages`, `settings`, `onReport`. |
152
- | `createRuntime` | function | The mock with the full service contract (health, admin, namespaces, credentials, presets, outbox, reporting webhooks). Options: `webhooks: {url, secret, retryDelaysMs?, fetch?}`, `messages`, `settings`, `clock`, `wallClock`, `seed`, `adminKey`, `onLog`, `sqlite`. |
151
+ | `CustomerIoAPI` | class | The in-process emulator: `fetch(request)`, `reset()`, `report(input)`, `profiles()`, `mergeProfile(id, patch)`, `transitionDelivery(id, state)`, `advanceClock(ms)`, `state`. Options: `sqlite`, `now`, `wallClock`, `namespace`, `messages`, `settings`, `onReport`. |
152
+ | `createRuntime` | function | The emulator with the full service contract (health, admin, namespaces, credentials, presets, outbox, reporting webhooks). Options: `webhooks: {url, secret, retryDelaysMs?, fetch?}`, `messages`, `settings`, `clock`, `wallClock`, `seed`, `adminKey`, `onLog`, `sqlite`. |
153
153
  | `CUSTOMERIO_PRESETS` | object | Every named fault preset. |
154
154
  | `CUSTOMERIO_NAMESPACE` | string | The service name, `"customerio"`. |
155
155
  | `REPORTING_WEBHOOK_PATH` | string | Our receiver's path, `/v1/customer-io/reporting-webhook`. |
package/SUPPORT.md CHANGED
@@ -3,10 +3,10 @@
3
3
  Generated from `openapi.yaml`; do not edit by hand.
4
4
 
5
5
  - operations in spec: **14**
6
- - supported by the mock: **14**
6
+ - supported by the emulator: **14**
7
7
  - parity enabled: **14**
8
8
 
9
- | operationId | route | mock | parity | notes |
9
+ | operationId | route | emulator | parity | notes |
10
10
  | --- | --- | --- | --- | --- |
11
11
  | `CdpIdentify` | `POST /v1/identify` | ✅ supported | ⚠️ unsafe (opt-in) | |
12
12
  | `CdpTrack` | `POST /v1/track` | ✅ supported | ⚠️ unsafe (opt-in) | |