@orpc/publisher 2.0.0-beta.2 → 2.0.0-beta.20
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/README.md +32 -21
- package/dist/adapters/memory.d.mts +7 -7
- package/dist/adapters/memory.d.ts +7 -7
- package/dist/adapters/memory.mjs +12 -12
- package/dist/adapters/redis.d.mts +8 -6
- package/dist/adapters/redis.d.ts +8 -6
- package/dist/adapters/redis.mjs +11 -11
- package/dist/adapters/upstash.d.mts +9 -7
- package/dist/adapters/upstash.d.ts +9 -7
- package/dist/adapters/upstash.mjs +12 -12
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
<a href="https://www.npmjs.com/package/@orpc/publisher">
|
|
8
8
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fpublisher?logo=npm" />
|
|
9
9
|
</a>
|
|
10
|
+
<a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
|
|
11
|
+
<img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
|
|
12
|
+
</a>
|
|
10
13
|
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
11
14
|
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
12
15
|
</a>
|
|
@@ -26,10 +29,10 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
26
29
|
|
|
27
30
|
**Core**
|
|
28
31
|
|
|
29
|
-
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define
|
|
30
|
-
- [@orpc/server](https://www.npmjs.com/package/@orpc/server):
|
|
31
|
-
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume
|
|
32
|
-
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi):
|
|
32
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
|
|
33
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
34
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
35
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
33
36
|
|
|
34
37
|
**Schema validation**
|
|
35
38
|
|
|
@@ -37,23 +40,30 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
37
40
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
38
41
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
39
42
|
|
|
43
|
+
**Built-in features**
|
|
44
|
+
|
|
45
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
46
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
47
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
48
|
+
|
|
40
49
|
**Framework & ecosystem integrations**
|
|
41
50
|
|
|
42
|
-
- [@orpc/next](https://www.npmjs.com/package/@orpc/
|
|
51
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
52
|
+
- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
43
53
|
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
54
|
+
- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
55
|
+
- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
|
|
44
56
|
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
- [@orpc/
|
|
49
|
-
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting.
|
|
50
|
-
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
58
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
59
|
+
- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
|
|
60
|
+
- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
51
61
|
|
|
52
62
|
**Observability**
|
|
53
63
|
|
|
54
|
-
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry):
|
|
55
|
-
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino):
|
|
56
|
-
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog):
|
|
64
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
65
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
66
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
57
67
|
|
|
58
68
|
## Sponsors
|
|
59
69
|
|
|
@@ -99,12 +109,10 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
99
109
|
<td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
100
110
|
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
101
111
|
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
102
|
-
<td align="center"><a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="139" alt="Andrew Peters"/><br />Andrew Peters</a></td>
|
|
103
112
|
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
113
|
+
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
|
|
104
114
|
</tr>
|
|
105
115
|
<tr>
|
|
106
|
-
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
|
|
107
|
-
<td align="center"><a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="139" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
108
116
|
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
109
117
|
<td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="139" alt="shota"/><br />shota</a></td>
|
|
110
118
|
</tr>
|
|
@@ -115,25 +123,25 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
115
123
|
<table>
|
|
116
124
|
<tr>
|
|
117
125
|
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="119" alt="David Walsh"/><br />David Walsh</a></td>
|
|
126
|
+
<td align="center"><a href="https://github.com/Nic13Gamer?ref=orpc" target="_blank" rel="noopener" title="Nicholas"><img src="https://avatars.githubusercontent.com/u/54724556?u=56a7ab430ce7a80d648ab6eba051d454a818ed0b&v=4" width="119" alt="Nicholas"/><br />Nicholas</a></td>
|
|
118
127
|
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="119" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
119
128
|
<td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="noopener" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="119" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
120
129
|
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="119" alt="soonoo"/><br />soonoo</a></td>
|
|
121
130
|
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="119" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
122
131
|
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="119" alt="Denis"/><br />Denis</a></td>
|
|
123
|
-
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
124
132
|
</tr>
|
|
125
133
|
<tr>
|
|
134
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
126
135
|
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="119" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
127
136
|
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="119" alt="Sam"/><br />Sam</a></td>
|
|
128
137
|
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="119" alt="Titoine"/><br />Titoine</a></td>
|
|
129
138
|
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
130
139
|
<td align="center"><a href="https://github.com/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
131
140
|
<td align="center"><a href="https://github.com/ldub?ref=orpc" target="_blank" rel="noopener" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
132
|
-
<td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
133
141
|
</tr>
|
|
134
142
|
<tr>
|
|
143
|
+
<td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
135
144
|
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="119" alt="Alex"/><br />Alex</a></td>
|
|
136
|
-
<td align="center"><a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="nattstack"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="119" alt="nattstack"/><br />nattstack</a></td>
|
|
137
145
|
<td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
138
146
|
</tr>
|
|
139
147
|
</table>
|
|
@@ -150,7 +158,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
150
158
|
<a href="https://github.com/theoludwig?ref=orpc" target="_blank" rel="noopener" title="Théo LUDWIG"><img src="https://avatars.githubusercontent.com/u/25207499?u=a6a9653725a2f574c07893748806668e0598cdbe&v=4" width="32" height="32" alt="Théo LUDWIG" /></a>
|
|
151
159
|
<a href="https://github.com/abhay-ramesh?ref=orpc" target="_blank" rel="noopener" title="Abhay Ramesh"><img src="https://avatars.githubusercontent.com/u/66196314?u=c5c2b0327b26606c2efcfaf17046ab18c3d25c57&v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
|
|
152
160
|
<a href="https://github.com/shr-ink?ref=orpc" target="_blank" rel="noopener" title="shr.ink oü"><img src="https://avatars.githubusercontent.com/u/139700438?v=4" width="32" height="32" alt="shr.ink oü" /></a>
|
|
153
|
-
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=
|
|
161
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=505e54608466ab53754f702973687b04c6424c1f&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
154
162
|
<a href="https://github.com/yzuyr?ref=orpc" target="_blank" rel="noopener" title="Ryuz"><img src="https://avatars.githubusercontent.com/u/196539378?u=d38374588d219b6748b16406982f6559411466d4&v=4" width="32" height="32" alt="Ryuz" /></a>
|
|
155
163
|
<a href="https://github.com/happyboy2022?ref=orpc" target="_blank" rel="noopener" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&v=4" width="32" height="32" alt="happyboy" /></a>
|
|
156
164
|
<a href="https://github.com/YiCChi?ref=orpc" target="_blank" rel="noopener" title="yicchi"><img src="https://avatars.githubusercontent.com/u/86967274?u=6c2756f09fe15dd94d572f560e979cd157982852&v=4" width="32" height="32" alt="yicchi" /></a>
|
|
@@ -164,7 +172,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
164
172
|
<a href="https://github.com/nelsonlaidev?ref=orpc" target="_blank" rel="noopener" title="Nelson Lai"><img src="https://avatars.githubusercontent.com/u/75498339?u=2fc0e0b95dd184c5ffb744df977cb15a18b60672&v=4" width="32" height="32" alt="Nelson Lai" /></a>
|
|
165
173
|
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
|
|
166
174
|
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
175
|
+
<a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
|
|
167
176
|
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
177
|
+
<a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="32" height="32" alt="Peter Adam" /></a>
|
|
168
178
|
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
169
179
|
<a href="https://github.com/NovakAnton?ref=orpc" target="_blank" rel="noopener" title="Novak Antonijevic"><img src="https://avatars.githubusercontent.com/u/157126729?u=ae49fa22292d55c0434ff0ca008206155b18663b&v=4" width="32" height="32" alt="Novak Antonijevic" /></a>
|
|
170
180
|
<a href="https://github.com/laduniestu?ref=orpc" target="_blank" rel="noopener" title="Laduni Estu Syalwa"><img src="https://avatars.githubusercontent.com/u/44757637?u=a2fc1ea8f7d827a96721176f79d30592d1c48059&v=4" width="32" height="32" alt="Laduni Estu Syalwa" /></a>
|
|
@@ -172,6 +182,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
172
182
|
<a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="noopener" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&v=4" width="32" height="32" alt="Illarion Koperski" /></a>
|
|
173
183
|
<a href="https://github.com/steelbrain?ref=orpc" target="_blank" rel="noopener" title="Anees Iqbal"><img src="https://avatars.githubusercontent.com/u/4278113?u=22b80b5399eed68ac76cd58b02961b0481f1db11&v=4" width="32" height="32" alt="Anees Iqbal" /></a>
|
|
174
184
|
<a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="noopener" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&v=4" width="32" height="32" alt="Sefa Eyeoglu" /></a>
|
|
185
|
+
<a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="natt"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="32" height="32" alt="natt" /></a>
|
|
175
186
|
<a href="https://github.com/ChromeGG?ref=orpc" target="_blank" rel="noopener" title="Adam Tkaczyk"><img src="https://avatars.githubusercontent.com/u/39050595?u=a58ca6042a6950e94e6e92442db76ef584279bc0&v=4" width="32" height="32" alt="Adam Tkaczyk" /></a>
|
|
176
187
|
<a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
|
|
177
188
|
</p>
|
|
@@ -3,16 +3,16 @@ import '@orpc/shared';
|
|
|
3
3
|
|
|
4
4
|
interface MemoryPublisherOptions extends PublisherOptions {
|
|
5
5
|
/**
|
|
6
|
-
* Configuration for event
|
|
6
|
+
* Configuration for event resume support.
|
|
7
7
|
*
|
|
8
8
|
* When enabled, published events are temporarily stored so new
|
|
9
9
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
10
10
|
*
|
|
11
11
|
* @default { enabled: false }
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
resume?: {
|
|
14
14
|
/**
|
|
15
|
-
* Whether event
|
|
15
|
+
* Whether event resume support is enabled.
|
|
16
16
|
*
|
|
17
17
|
* When enabled, published events are temporarily stored so new
|
|
18
18
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -21,7 +21,7 @@ interface MemoryPublisherOptions extends PublisherOptions {
|
|
|
21
21
|
*/
|
|
22
22
|
enabled: boolean;
|
|
23
23
|
/**
|
|
24
|
-
* How long (in seconds) to retain events for
|
|
24
|
+
* How long (in seconds) to retain events for resume.
|
|
25
25
|
*
|
|
26
26
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
27
27
|
* some events may remain available slightly longer than this period.
|
|
@@ -35,9 +35,9 @@ declare class MemoryPublisher<T extends Record<string, object>> extends Publishe
|
|
|
35
35
|
private readonly listenersMap;
|
|
36
36
|
private readonly idGenerator;
|
|
37
37
|
private readonly eventsMap;
|
|
38
|
-
private readonly
|
|
39
|
-
private readonly
|
|
40
|
-
constructor({
|
|
38
|
+
private readonly resumeEnabled;
|
|
39
|
+
private readonly resumeSeconds;
|
|
40
|
+
constructor({ resume, ...options }?: MemoryPublisherOptions);
|
|
41
41
|
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
42
42
|
protected subscribeListener<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
43
43
|
private lastCleanupTime;
|
|
@@ -3,16 +3,16 @@ import '@orpc/shared';
|
|
|
3
3
|
|
|
4
4
|
interface MemoryPublisherOptions extends PublisherOptions {
|
|
5
5
|
/**
|
|
6
|
-
* Configuration for event
|
|
6
|
+
* Configuration for event resume support.
|
|
7
7
|
*
|
|
8
8
|
* When enabled, published events are temporarily stored so new
|
|
9
9
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
10
10
|
*
|
|
11
11
|
* @default { enabled: false }
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
resume?: {
|
|
14
14
|
/**
|
|
15
|
-
* Whether event
|
|
15
|
+
* Whether event resume support is enabled.
|
|
16
16
|
*
|
|
17
17
|
* When enabled, published events are temporarily stored so new
|
|
18
18
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -21,7 +21,7 @@ interface MemoryPublisherOptions extends PublisherOptions {
|
|
|
21
21
|
*/
|
|
22
22
|
enabled: boolean;
|
|
23
23
|
/**
|
|
24
|
-
* How long (in seconds) to retain events for
|
|
24
|
+
* How long (in seconds) to retain events for resume.
|
|
25
25
|
*
|
|
26
26
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
27
27
|
* some events may remain available slightly longer than this period.
|
|
@@ -35,9 +35,9 @@ declare class MemoryPublisher<T extends Record<string, object>> extends Publishe
|
|
|
35
35
|
private readonly listenersMap;
|
|
36
36
|
private readonly idGenerator;
|
|
37
37
|
private readonly eventsMap;
|
|
38
|
-
private readonly
|
|
39
|
-
private readonly
|
|
40
|
-
constructor({
|
|
38
|
+
private readonly resumeEnabled;
|
|
39
|
+
private readonly resumeSeconds;
|
|
40
|
+
constructor({ resume, ...options }?: MemoryPublisherOptions);
|
|
41
41
|
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
42
42
|
protected subscribeListener<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
43
43
|
private lastCleanupTime;
|
package/dist/adapters/memory.mjs
CHANGED
|
@@ -6,17 +6,17 @@ class MemoryPublisher extends Publisher {
|
|
|
6
6
|
listenersMap = /* @__PURE__ */ new Map();
|
|
7
7
|
idGenerator = new SequentialIdGenerator();
|
|
8
8
|
eventsMap = /* @__PURE__ */ new Map();
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
constructor({
|
|
9
|
+
resumeEnabled;
|
|
10
|
+
resumeSeconds;
|
|
11
|
+
constructor({ resume, ...options } = {}) {
|
|
12
12
|
super(options);
|
|
13
|
-
this.
|
|
14
|
-
this.
|
|
13
|
+
this.resumeEnabled = resume?.enabled ?? false;
|
|
14
|
+
this.resumeSeconds = resume?.seconds ?? 300;
|
|
15
15
|
}
|
|
16
16
|
async publish(event, payload) {
|
|
17
17
|
this.cleanup();
|
|
18
|
-
if (this.
|
|
19
|
-
const expiresAt = Date.now() + this.
|
|
18
|
+
if (this.resumeEnabled) {
|
|
19
|
+
const expiresAt = Date.now() + this.resumeSeconds * 1e3;
|
|
20
20
|
let bucket = this.eventsMap.get(event);
|
|
21
21
|
if (!bucket) {
|
|
22
22
|
this.eventsMap.set(event, bucket = []);
|
|
@@ -30,10 +30,10 @@ class MemoryPublisher extends Publisher {
|
|
|
30
30
|
}
|
|
31
31
|
async subscribeListener(event, listener, options) {
|
|
32
32
|
this.cleanup();
|
|
33
|
-
if (this.
|
|
33
|
+
if (this.resumeEnabled && options?.lastEventId !== void 0) {
|
|
34
34
|
const bucket = this.eventsMap.get(event);
|
|
35
35
|
if (bucket?.length) {
|
|
36
|
-
const startIdx =
|
|
36
|
+
const startIdx = findResumeStartIndex(bucket, options.lastEventId);
|
|
37
37
|
for (let i = startIdx; i < bucket.length; i++) {
|
|
38
38
|
listener(bucket[i].payload);
|
|
39
39
|
}
|
|
@@ -53,11 +53,11 @@ class MemoryPublisher extends Publisher {
|
|
|
53
53
|
}
|
|
54
54
|
lastCleanupTime = 0;
|
|
55
55
|
cleanup() {
|
|
56
|
-
if (!this.
|
|
56
|
+
if (!this.resumeEnabled) {
|
|
57
57
|
return;
|
|
58
58
|
}
|
|
59
59
|
const now = Date.now();
|
|
60
|
-
if (now - this.lastCleanupTime < this.
|
|
60
|
+
if (now - this.lastCleanupTime < this.resumeSeconds * 1e3) {
|
|
61
61
|
return;
|
|
62
62
|
}
|
|
63
63
|
this.lastCleanupTime = now;
|
|
@@ -69,7 +69,7 @@ class MemoryPublisher extends Publisher {
|
|
|
69
69
|
}
|
|
70
70
|
}
|
|
71
71
|
}
|
|
72
|
-
function
|
|
72
|
+
function findResumeStartIndex(bucket, lastEventId) {
|
|
73
73
|
let lo = 0;
|
|
74
74
|
let hi = bucket.length;
|
|
75
75
|
while (lo < hi) {
|
|
@@ -14,6 +14,8 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
14
14
|
subscriber?: undefined | RedisClientType<any, any, any, any, any>;
|
|
15
15
|
/**
|
|
16
16
|
* The prefix to use for Redis keys.
|
|
17
|
+
*
|
|
18
|
+
* @default ''
|
|
17
19
|
*/
|
|
18
20
|
prefix?: string;
|
|
19
21
|
/**
|
|
@@ -23,16 +25,16 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
23
25
|
*/
|
|
24
26
|
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
25
27
|
/**
|
|
26
|
-
* Configuration for event
|
|
28
|
+
* Configuration for event resume support.
|
|
27
29
|
*
|
|
28
30
|
* When enabled, published events are temporarily stored so new
|
|
29
31
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
30
32
|
*
|
|
31
33
|
* @default { enabled: false }
|
|
32
34
|
*/
|
|
33
|
-
|
|
35
|
+
resume?: {
|
|
34
36
|
/**
|
|
35
|
-
* Whether event
|
|
37
|
+
* Whether event resume support is enabled.
|
|
36
38
|
*
|
|
37
39
|
* When enabled, published events are temporarily stored so new
|
|
38
40
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -41,7 +43,7 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
41
43
|
*/
|
|
42
44
|
enabled: boolean;
|
|
43
45
|
/**
|
|
44
|
-
* How long (in seconds) to retain events for
|
|
46
|
+
* How long (in seconds) to retain events for resume.
|
|
45
47
|
*
|
|
46
48
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
47
49
|
* some events may remain available slightly longer than this period.
|
|
@@ -56,8 +58,8 @@ declare class RedisPublisher<T extends Record<string, object>> extends Publisher
|
|
|
56
58
|
private readonly subscriber;
|
|
57
59
|
private readonly prefix;
|
|
58
60
|
private readonly serializer;
|
|
59
|
-
private readonly
|
|
60
|
-
private readonly
|
|
61
|
+
private readonly resumeEnabled;
|
|
62
|
+
private readonly resumeSeconds;
|
|
61
63
|
/**
|
|
62
64
|
* The exactness of the `XTRIM` command.
|
|
63
65
|
* Used for testing purpose.
|
package/dist/adapters/redis.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
14
14
|
subscriber?: undefined | RedisClientType<any, any, any, any, any>;
|
|
15
15
|
/**
|
|
16
16
|
* The prefix to use for Redis keys.
|
|
17
|
+
*
|
|
18
|
+
* @default ''
|
|
17
19
|
*/
|
|
18
20
|
prefix?: string;
|
|
19
21
|
/**
|
|
@@ -23,16 +25,16 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
23
25
|
*/
|
|
24
26
|
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
25
27
|
/**
|
|
26
|
-
* Configuration for event
|
|
28
|
+
* Configuration for event resume support.
|
|
27
29
|
*
|
|
28
30
|
* When enabled, published events are temporarily stored so new
|
|
29
31
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
30
32
|
*
|
|
31
33
|
* @default { enabled: false }
|
|
32
34
|
*/
|
|
33
|
-
|
|
35
|
+
resume?: {
|
|
34
36
|
/**
|
|
35
|
-
* Whether event
|
|
37
|
+
* Whether event resume support is enabled.
|
|
36
38
|
*
|
|
37
39
|
* When enabled, published events are temporarily stored so new
|
|
38
40
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -41,7 +43,7 @@ interface RedisPublisherOptions extends PublisherOptions {
|
|
|
41
43
|
*/
|
|
42
44
|
enabled: boolean;
|
|
43
45
|
/**
|
|
44
|
-
* How long (in seconds) to retain events for
|
|
46
|
+
* How long (in seconds) to retain events for resume.
|
|
45
47
|
*
|
|
46
48
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
47
49
|
* some events may remain available slightly longer than this period.
|
|
@@ -56,8 +58,8 @@ declare class RedisPublisher<T extends Record<string, object>> extends Publisher
|
|
|
56
58
|
private readonly subscriber;
|
|
57
59
|
private readonly prefix;
|
|
58
60
|
private readonly serializer;
|
|
59
|
-
private readonly
|
|
60
|
-
private readonly
|
|
61
|
+
private readonly resumeEnabled;
|
|
62
|
+
private readonly resumeSeconds;
|
|
61
63
|
/**
|
|
62
64
|
* The exactness of the `XTRIM` command.
|
|
63
65
|
* Used for testing purpose.
|
package/dist/adapters/redis.mjs
CHANGED
|
@@ -9,15 +9,15 @@ class RedisPublisher extends Publisher {
|
|
|
9
9
|
this.redis = redis;
|
|
10
10
|
this.prefix = options.prefix ?? "";
|
|
11
11
|
this.serializer = options.serializer ?? new RPCSerializer();
|
|
12
|
-
this.
|
|
13
|
-
this.
|
|
12
|
+
this.resumeEnabled = options.resume?.enabled ?? false;
|
|
13
|
+
this.resumeSeconds = options.resume?.seconds ?? 300;
|
|
14
14
|
this.subscriber = options.subscriber ?? redis.duplicate();
|
|
15
15
|
}
|
|
16
16
|
subscriber;
|
|
17
17
|
prefix;
|
|
18
18
|
serializer;
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
resumeEnabled;
|
|
20
|
+
resumeSeconds;
|
|
21
21
|
/**
|
|
22
22
|
* The exactness of the `XTRIM` command.
|
|
23
23
|
* Used for testing purpose.
|
|
@@ -31,16 +31,16 @@ class RedisPublisher extends Publisher {
|
|
|
31
31
|
if (!this.redis.isOpen) {
|
|
32
32
|
await this.redis.connect();
|
|
33
33
|
}
|
|
34
|
-
if (this.
|
|
34
|
+
if (this.resumeEnabled) {
|
|
35
35
|
const now = Date.now();
|
|
36
36
|
for (const [event2, firstPublishTime] of this.firstPublishTimeMap) {
|
|
37
|
-
if (firstPublishTime + this.
|
|
37
|
+
if (firstPublishTime + this.resumeSeconds * 1e3 < now) {
|
|
38
38
|
this.firstPublishTimeMap.delete(event2);
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
41
|
if (!this.firstPublishTimeMap.has(event)) {
|
|
42
42
|
this.firstPublishTimeMap.set(event, now);
|
|
43
|
-
const result = await this.redis.multi().xAdd(redisKey, "*", { data: stringifyJSON(data) }).xTrim(redisKey, "MINID", `${now - this.
|
|
43
|
+
const result = await this.redis.multi().xAdd(redisKey, "*", { data: stringifyJSON(data) }).xTrim(redisKey, "MINID", `${now - this.resumeSeconds * 1e3}-0`, { strategyModifier: this.xTrimExactness }).expire(redisKey, this.resumeSeconds * 2).exec();
|
|
44
44
|
id = result[0];
|
|
45
45
|
} else {
|
|
46
46
|
id = await this.redis.xAdd(redisKey, "*", { data: stringifyJSON(data) });
|
|
@@ -54,14 +54,14 @@ class RedisPublisher extends Publisher {
|
|
|
54
54
|
await this.subscriber.connect();
|
|
55
55
|
}
|
|
56
56
|
let pendingPayloads = [];
|
|
57
|
-
const
|
|
57
|
+
const resumedIds = /* @__PURE__ */ new Set();
|
|
58
58
|
const deduplicatingListener = (payload) => {
|
|
59
59
|
if (pendingPayloads) {
|
|
60
60
|
pendingPayloads.push(payload);
|
|
61
61
|
return;
|
|
62
62
|
}
|
|
63
63
|
const id = getEventMeta(payload)?.id;
|
|
64
|
-
if (id !== void 0 &&
|
|
64
|
+
if (id !== void 0 && resumedIds.has(id)) {
|
|
65
65
|
return;
|
|
66
66
|
}
|
|
67
67
|
originalListener(payload);
|
|
@@ -78,7 +78,7 @@ class RedisPublisher extends Publisher {
|
|
|
78
78
|
try {
|
|
79
79
|
const subscribePromise = this.subscriber.subscribe(redisKey, redisListener);
|
|
80
80
|
try {
|
|
81
|
-
if (this.
|
|
81
|
+
if (this.resumeEnabled && lastEventId !== void 0) {
|
|
82
82
|
if (!this.redis.isOpen) {
|
|
83
83
|
await this.redis.connect();
|
|
84
84
|
}
|
|
@@ -89,7 +89,7 @@ class RedisPublisher extends Publisher {
|
|
|
89
89
|
const rawData = message.data;
|
|
90
90
|
const data = parseEmptyableJSON(rawData);
|
|
91
91
|
const payload = this.deserializePayload(id, data);
|
|
92
|
-
|
|
92
|
+
resumedIds.add(id);
|
|
93
93
|
originalListener(payload);
|
|
94
94
|
}
|
|
95
95
|
}
|
|
@@ -6,6 +6,8 @@ import '@orpc/shared';
|
|
|
6
6
|
interface UpstashPublisherOptions extends PublisherOptions {
|
|
7
7
|
/**
|
|
8
8
|
* The prefix to use for Redis keys.
|
|
9
|
+
*
|
|
10
|
+
* @default ''
|
|
9
11
|
*/
|
|
10
12
|
prefix?: string;
|
|
11
13
|
/**
|
|
@@ -15,16 +17,16 @@ interface UpstashPublisherOptions extends PublisherOptions {
|
|
|
15
17
|
*/
|
|
16
18
|
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
17
19
|
/**
|
|
18
|
-
* Configuration for event
|
|
20
|
+
* Configuration for event resume support.
|
|
19
21
|
*
|
|
20
22
|
* When enabled, published events are temporarily stored so new
|
|
21
23
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
22
24
|
*
|
|
23
25
|
* @default { enabled: false }
|
|
24
26
|
*/
|
|
25
|
-
|
|
27
|
+
resume?: {
|
|
26
28
|
/**
|
|
27
|
-
* Whether event
|
|
29
|
+
* Whether event resume support is enabled.
|
|
28
30
|
*
|
|
29
31
|
* When enabled, published events are temporarily stored so new
|
|
30
32
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -33,7 +35,7 @@ interface UpstashPublisherOptions extends PublisherOptions {
|
|
|
33
35
|
*/
|
|
34
36
|
enabled: boolean;
|
|
35
37
|
/**
|
|
36
|
-
* How long (in seconds) to retain events for
|
|
38
|
+
* How long (in seconds) to retain events for resume.
|
|
37
39
|
*
|
|
38
40
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
39
41
|
* some events may remain available slightly longer than this period.
|
|
@@ -50,14 +52,14 @@ declare class UpstashPublisher<T extends Record<string, object>> extends Publish
|
|
|
50
52
|
private readonly listenersMap;
|
|
51
53
|
private readonly onErrorsMap;
|
|
52
54
|
private readonly subscriptionMap;
|
|
53
|
-
private readonly
|
|
54
|
-
private readonly
|
|
55
|
+
private readonly resumeEnabled;
|
|
56
|
+
private readonly resumeSeconds;
|
|
55
57
|
/**
|
|
56
58
|
* The exactness of the `XTRIM` command.
|
|
57
59
|
* Used for testing purpose.
|
|
58
60
|
*/
|
|
59
61
|
private readonly xTrimExactness;
|
|
60
|
-
constructor(redis: Redis, {
|
|
62
|
+
constructor(redis: Redis, { resume, prefix, serializer, ...options }?: UpstashPublisherOptions);
|
|
61
63
|
private readonly firstPublishTimeMap;
|
|
62
64
|
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
63
65
|
protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
@@ -6,6 +6,8 @@ import '@orpc/shared';
|
|
|
6
6
|
interface UpstashPublisherOptions extends PublisherOptions {
|
|
7
7
|
/**
|
|
8
8
|
* The prefix to use for Redis keys.
|
|
9
|
+
*
|
|
10
|
+
* @default ''
|
|
9
11
|
*/
|
|
10
12
|
prefix?: string;
|
|
11
13
|
/**
|
|
@@ -15,16 +17,16 @@ interface UpstashPublisherOptions extends PublisherOptions {
|
|
|
15
17
|
*/
|
|
16
18
|
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
17
19
|
/**
|
|
18
|
-
* Configuration for event
|
|
20
|
+
* Configuration for event resume support.
|
|
19
21
|
*
|
|
20
22
|
* When enabled, published events are temporarily stored so new
|
|
21
23
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
22
24
|
*
|
|
23
25
|
* @default { enabled: false }
|
|
24
26
|
*/
|
|
25
|
-
|
|
27
|
+
resume?: {
|
|
26
28
|
/**
|
|
27
|
-
* Whether event
|
|
29
|
+
* Whether event resume support is enabled.
|
|
28
30
|
*
|
|
29
31
|
* When enabled, published events are temporarily stored so new
|
|
30
32
|
* subscribers can resume from a previous position using `lastEventId`.
|
|
@@ -33,7 +35,7 @@ interface UpstashPublisherOptions extends PublisherOptions {
|
|
|
33
35
|
*/
|
|
34
36
|
enabled: boolean;
|
|
35
37
|
/**
|
|
36
|
-
* How long (in seconds) to retain events for
|
|
38
|
+
* How long (in seconds) to retain events for resume.
|
|
37
39
|
*
|
|
38
40
|
* Expired events are cleaned up lazily for performance reasons, so
|
|
39
41
|
* some events may remain available slightly longer than this period.
|
|
@@ -50,14 +52,14 @@ declare class UpstashPublisher<T extends Record<string, object>> extends Publish
|
|
|
50
52
|
private readonly listenersMap;
|
|
51
53
|
private readonly onErrorsMap;
|
|
52
54
|
private readonly subscriptionMap;
|
|
53
|
-
private readonly
|
|
54
|
-
private readonly
|
|
55
|
+
private readonly resumeEnabled;
|
|
56
|
+
private readonly resumeSeconds;
|
|
55
57
|
/**
|
|
56
58
|
* The exactness of the `XTRIM` command.
|
|
57
59
|
* Used for testing purpose.
|
|
58
60
|
*/
|
|
59
61
|
private readonly xTrimExactness;
|
|
60
|
-
constructor(redis: Redis, {
|
|
62
|
+
constructor(redis: Redis, { resume, prefix, serializer, ...options }?: UpstashPublisherOptions);
|
|
61
63
|
private readonly firstPublishTimeMap;
|
|
62
64
|
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
63
65
|
protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
@@ -4,12 +4,12 @@ import { unwrapEvent, withEventMeta, getEventMeta } from '@standardserver/core';
|
|
|
4
4
|
import { P as Publisher } from '../shared/publisher.BSQf8ybR.mjs';
|
|
5
5
|
|
|
6
6
|
class UpstashPublisher extends Publisher {
|
|
7
|
-
constructor(redis, {
|
|
7
|
+
constructor(redis, { resume, prefix, serializer, ...options } = {}) {
|
|
8
8
|
super(options);
|
|
9
9
|
this.redis = redis;
|
|
10
10
|
this.prefix = prefix ?? "";
|
|
11
|
-
this.
|
|
12
|
-
this.
|
|
11
|
+
this.resumeEnabled = resume?.enabled ?? false;
|
|
12
|
+
this.resumeSeconds = resume?.seconds ?? 300;
|
|
13
13
|
this.serializer = serializer ?? new RPCSerializer();
|
|
14
14
|
}
|
|
15
15
|
prefix;
|
|
@@ -18,8 +18,8 @@ class UpstashPublisher extends Publisher {
|
|
|
18
18
|
onErrorsMap = /* @__PURE__ */ new Map();
|
|
19
19
|
subscriptionMap = /* @__PURE__ */ new Map();
|
|
20
20
|
// Upstash subscription objects
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
resumeEnabled;
|
|
22
|
+
resumeSeconds;
|
|
23
23
|
/**
|
|
24
24
|
* The exactness of the `XTRIM` command.
|
|
25
25
|
* Used for testing purpose.
|
|
@@ -30,16 +30,16 @@ class UpstashPublisher extends Publisher {
|
|
|
30
30
|
const redisKey = `${this.prefix}${event}`;
|
|
31
31
|
const data = this.serializePayload(payload);
|
|
32
32
|
let id;
|
|
33
|
-
if (this.
|
|
33
|
+
if (this.resumeEnabled) {
|
|
34
34
|
const now = Date.now();
|
|
35
35
|
for (const [event2, firstPublishTime] of this.firstPublishTimeMap) {
|
|
36
|
-
if (firstPublishTime + this.
|
|
36
|
+
if (firstPublishTime + this.resumeSeconds * 1e3 < now) {
|
|
37
37
|
this.firstPublishTimeMap.delete(event2);
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
if (!this.firstPublishTimeMap.has(event)) {
|
|
41
41
|
this.firstPublishTimeMap.set(event, now);
|
|
42
|
-
const results = await this.redis.multi().xadd(redisKey, "*", { data }).xtrim(redisKey, { strategy: "MINID", exactness: this.xTrimExactness, threshold: `${now - this.
|
|
42
|
+
const results = await this.redis.multi().xadd(redisKey, "*", { data }).xtrim(redisKey, { strategy: "MINID", exactness: this.xTrimExactness, threshold: `${now - this.resumeSeconds * 1e3}-0` }).expire(redisKey, this.resumeSeconds * 2).exec();
|
|
43
43
|
id = results[0];
|
|
44
44
|
} else {
|
|
45
45
|
id = await this.redis.xadd(redisKey, "*", { data });
|
|
@@ -50,14 +50,14 @@ class UpstashPublisher extends Publisher {
|
|
|
50
50
|
async subscribeListener(event, originalListener, { lastEventId, onError } = {}) {
|
|
51
51
|
const redisKey = `${this.prefix}${event}`;
|
|
52
52
|
let pendingPayloads = [];
|
|
53
|
-
const
|
|
53
|
+
const resumedIds = /* @__PURE__ */ new Set();
|
|
54
54
|
const deduplicatingListener = (payload) => {
|
|
55
55
|
if (pendingPayloads) {
|
|
56
56
|
pendingPayloads.push(payload);
|
|
57
57
|
return;
|
|
58
58
|
}
|
|
59
59
|
const id = getEventMeta(payload)?.id;
|
|
60
|
-
if (id !== void 0 &&
|
|
60
|
+
if (id !== void 0 && resumedIds.has(id)) {
|
|
61
61
|
return;
|
|
62
62
|
}
|
|
63
63
|
originalListener(payload);
|
|
@@ -70,14 +70,14 @@ class UpstashPublisher extends Publisher {
|
|
|
70
70
|
try {
|
|
71
71
|
const subscribeEventPromise = this.subscribeEvent(event);
|
|
72
72
|
try {
|
|
73
|
-
if (this.
|
|
73
|
+
if (this.resumeEnabled && lastEventId !== void 0) {
|
|
74
74
|
const results = await this.redis.xread(redisKey, lastEventId);
|
|
75
75
|
if (results && results[0]) {
|
|
76
76
|
const [_, items] = results[0];
|
|
77
77
|
for (const [id, fields] of items) {
|
|
78
78
|
const data = fields[1];
|
|
79
79
|
const payload = this.deserializePayload(id, data);
|
|
80
|
-
|
|
80
|
+
resumedIds.add(id);
|
|
81
81
|
originalListener(payload);
|
|
82
82
|
}
|
|
83
83
|
}
|
package/dist/index.d.mts
CHANGED
|
@@ -2,7 +2,7 @@ import { ThrowableError, AsyncIteratorClass } from '@orpc/shared';
|
|
|
2
2
|
|
|
3
3
|
interface PublisherOptions {
|
|
4
4
|
/**
|
|
5
|
-
* Maximum number of events to buffer for
|
|
5
|
+
* Maximum number of events to buffer for AsyncIteratorObject subscribers.
|
|
6
6
|
*
|
|
7
7
|
* If the buffer exceeds this limit, the oldest event is dropped.
|
|
8
8
|
* This prevents unbounded memory growth if consumers process events slowly.
|
|
@@ -68,7 +68,7 @@ declare abstract class Publisher<T extends Record<string, object>> {
|
|
|
68
68
|
*/
|
|
69
69
|
subscribe<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
70
70
|
/**
|
|
71
|
-
* Subscribes to a specific event using an
|
|
71
|
+
* Subscribes to a specific event using an AsyncIteratorObject.
|
|
72
72
|
* Useful for `for await...of` loops with optional buffering and abort support.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { ThrowableError, AsyncIteratorClass } from '@orpc/shared';
|
|
|
2
2
|
|
|
3
3
|
interface PublisherOptions {
|
|
4
4
|
/**
|
|
5
|
-
* Maximum number of events to buffer for
|
|
5
|
+
* Maximum number of events to buffer for AsyncIteratorObject subscribers.
|
|
6
6
|
*
|
|
7
7
|
* If the buffer exceeds this limit, the oldest event is dropped.
|
|
8
8
|
* This prevents unbounded memory growth if consumers process events slowly.
|
|
@@ -68,7 +68,7 @@ declare abstract class Publisher<T extends Record<string, object>> {
|
|
|
68
68
|
*/
|
|
69
69
|
subscribe<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
70
70
|
/**
|
|
71
|
-
* Subscribes to a specific event using an
|
|
71
|
+
* Subscribes to a specific event using an AsyncIteratorObject.
|
|
72
72
|
* Useful for `for await...of` loops with optional buffering and abort support.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/publisher",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.20",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
@@ -52,13 +52,13 @@
|
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"@standardserver/core": "^0.0
|
|
56
|
-
"@orpc/client": "2.0.0-beta.
|
|
57
|
-
"@orpc/shared": "2.0.0-beta.
|
|
55
|
+
"@standardserver/core": "^0.5.0",
|
|
56
|
+
"@orpc/client": "2.0.0-beta.20",
|
|
57
|
+
"@orpc/shared": "2.0.0-beta.20"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
60
|
"@upstash/redis": "^1.38.0",
|
|
61
|
-
"redis": "^6.0.
|
|
61
|
+
"redis": "^6.0.1"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
64
|
"build": "unbuild",
|