Skip to content

Commit 86e42da

Browse files
committed
docs(spec): vendor is the token type the sender routes on; five-way vendor list
Contract-review should-fixes: the direct transport routes on vendor today (PushService.send picks transports[message.vendor]); the hosted relay, the default, does once served. The domestic vendor list uses the ADR's separators, HMS / Honor / Xiaomi / OPPO / vivo. Claude-Session: https://claude.ai/code/session_01L6bhgTqqeHSwZYJmApbDCa Co-authored-by: Claude <noreply@anthropic.com>
1 parent 88640a0 commit 86e42da

4 files changed

Lines changed: 18 additions & 14 deletions

File tree

‎.changeset/29960-push-vendor-docblocks.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ docs(spec): the push vendor docblocks read ADR-0012 §6.1 as amended
77
Clause-②: no
88
Metadata-protocol: none
99

10-
The `PushVendorSchema` docblock and the push transport and stored device docblocks (`system/push-config.zod.ts`, `system/push-device.zod.ts`) no longer say the domestic Android vendors plug in as alternate channel plugins. They now say what ADR-0012 §6.1 decides: `vendor` is the token type the hosted relay routes on, core ships `apns` and `fcm`, and phase 2 adds HMS / Honor, Xiaomi, OPPO and vivo behind the same relay, with no per-vendor plugin and no per-vendor channel. A new `PushVendorSchema` value is still a spec change made together with the relay's routing for that vendor. Comment text only: no schema, `.describe()`, export or default changes, and `PushVendorSchema` stays `apns | fcm`.
10+
The `PushVendorSchema` docblock and the push transport and stored device docblocks (`system/push-config.zod.ts`, `system/push-device.zod.ts`) no longer say the domestic Android vendors plug in as alternate channel plugins. They now say what ADR-0012 §6.1 decides: `vendor` is the token type the sender routes on (the direct transport today, the hosted relay, the default, once served), core ships `apns` and `fcm`, and phase 2 adds HMS / Honor / Xiaomi / OPPO / vivo behind the relay, with no per-vendor plugin and no per-vendor channel. A new `PushVendorSchema` value is still a spec change made together with the relay's routing for that vendor. Comment text only: no schema, `.describe()`, export or default changes, and `PushVendorSchema` stays `apns | fcm`.

‎content/docs/kernel/runtime-services/push-service.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,10 @@ service its server gets.
8686
Each vendor block is optional, and at least one is required. A vendor with no
8787
block is a vendor this deployment does not push to; devices registered on it are
8888
skipped. Only `apns` and `fcm` ship today. The other Android vendors (HMS /
89-
Honor, Xiaomi, OPPO, vivo) are planned for a later phase behind the hosted relay
90-
(below), as further values of `vendor`, the token type the relay routes on, and
91-
not as plugins or channels of their own.
89+
Honor / Xiaomi / OPPO / vivo) are planned for a later phase behind the hosted
90+
relay (below), as further values of `vendor`, the token type the sender routes
91+
on (this service's transports today, the relay once it is served), and not as
92+
plugins or channels of their own.
9293

9394
### Credential references
9495

‎packages/spec/src/system/push-config.zod.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,20 @@ import { strictObject } from '../shared/strict-object';
8282
* it: the vendor blocks hold no secret to override, and each `credentialRef`
8383
* already names one.
8484
*
85-
* Out of scope here: the domestic Android vendors (HMS / Honor, Xiaomi, OPPO,
86-
* vivo). ADR-0012 §6.1 has the hosted relay front them in phase 2, as further
87-
* values of `vendor`, the token type the relay routes on; there is no
88-
* per-vendor plugin and no per-vendor channel.
85+
* Out of scope here: the domestic Android vendors (HMS / Honor / Xiaomi /
86+
* OPPO / vivo). ADR-0012 §6.1 has the hosted relay front them in phase 2, as
87+
* further values of `vendor`, the token type the sender routes on; there is
88+
* no per-vendor plugin and no per-vendor channel.
8989
*/
9090

9191
/**
9292
* Push vendors core delivers through: `apns` (Apple) and `fcm` (Firebase).
9393
*
94-
* Closed on purpose. `vendor` is the token type the hosted relay routes on
95-
* (ADR-0012 §6.1): phase 1 routes these two, and phase 2 adds the domestic
96-
* Android vendors (HMS / Honor, Xiaomi, OPPO, vivo) behind the same relay,
97-
* with no per-vendor plugin and no per-vendor channel. So a new value here is
94+
* Closed on purpose. `vendor` is the token type the sender routes on: the
95+
* direct transport today, the hosted relay (the default) once served (ADR-0012
96+
* §6.1). Phase 1 routes these two, and phase 2 adds the domestic Android
97+
* vendors (HMS / Honor / Xiaomi / OPPO / vivo) behind the relay, with no
98+
* per-vendor plugin and no per-vendor channel. So a new value here is
9899
* a spec change made together with its transport: the relay's routing for
99100
* that vendor.
100101
*/

‎packages/spec/src/system/push-device.zod.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@ import { PUSH_SERVER_ORIGIN_MESSAGE, PUSH_SERVER_ORIGIN_PATTERN } from './push-s
4747
* `invalidatedAt`.
4848
*
4949
* Narrowed from the ADR-0012 §6 sketch: `vendor` is the core pair (`apns` |
50-
* `fcm`; it is the token type the hosted relay routes on, and the domestic
51-
* Android vendors join it in phase 2 behind the same relay, ADR-0012 §6.1) and
50+
* `fcm`; it is the token type the sender routes on: the direct transport
51+
* today, the hosted relay (the default) once served, and the domestic Android
52+
* vendors (HMS / Honor / Xiaomi / OPPO / vivo) join it in phase 2 behind the
53+
* relay, ADR-0012 §6.1) and
5254
* `platform` is the registration's own three (`ios` | `android` | `web`).
5355
*/
5456
export const UserDeviceSchema = lazySchema(() => z.object({

0 commit comments

Comments
 (0)