@orpc/publisher 2.0.0-beta.1
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/LICENSE +21 -0
- package/README.md +188 -0
- package/dist/adapters/memory.d.mts +48 -0
- package/dist/adapters/memory.d.ts +48 -0
- package/dist/adapters/memory.mjs +100 -0
- package/dist/adapters/redis.d.mts +75 -0
- package/dist/adapters/redis.d.ts +75 -0
- package/dist/adapters/redis.mjs +125 -0
- package/dist/adapters/upstash.d.mts +72 -0
- package/dist/adapters/upstash.d.ts +72 -0
- package/dist/adapters/upstash.mjs +200 -0
- package/dist/index.d.mts +85 -0
- package/dist/index.d.ts +85 -0
- package/dist/index.mjs +2 -0
- package/dist/shared/publisher.BSQf8ybR.mjs +74 -0
- package/package.json +67 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 oRPC
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
<h1 align="center">oRPC - Typesafe APIs Made Simple πͺ</h1>
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
5
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://www.npmjs.com/package/@orpc/publisher">
|
|
8
|
+
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fpublisher?logo=npm" />
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
11
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
12
|
+
</a>
|
|
13
|
+
<a href="https://discord.gg/TXEbwRBvQn">
|
|
14
|
+
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
15
|
+
</a>
|
|
16
|
+
<a href="https://deepwiki.com/middleapi/orpc">
|
|
17
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
18
|
+
</a>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## Documentation
|
|
22
|
+
|
|
23
|
+
You can read the documentation [here](https://orpc.dev).
|
|
24
|
+
|
|
25
|
+
## Packages
|
|
26
|
+
|
|
27
|
+
**Core**
|
|
28
|
+
|
|
29
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define type-safe contracts for your API.
|
|
30
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Implement your API or contract on the server.
|
|
31
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API from the client with full type safety.
|
|
32
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Bring OpenAPI compatibility to your APIs.
|
|
33
|
+
|
|
34
|
+
**Schema validation**
|
|
35
|
+
|
|
36
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
37
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
38
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
39
|
+
|
|
40
|
+
**Framework & ecosystem integrations**
|
|
41
|
+
|
|
42
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/react): Use oRPC with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
43
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
44
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
45
|
+
|
|
46
|
+
**Built-in features**
|
|
47
|
+
|
|
48
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub.
|
|
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.
|
|
51
|
+
|
|
52
|
+
**Observability**
|
|
53
|
+
|
|
54
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Instrument your API with [OpenTelemetry](https://opentelemetry.io/).
|
|
55
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Log with [Pino](https://getpino.io/).
|
|
56
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Log with [Evlog](https://evlog.dev/).
|
|
57
|
+
|
|
58
|
+
## Sponsors
|
|
59
|
+
|
|
60
|
+
Like what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh). Every bit helps! π
|
|
61
|
+
|
|
62
|
+
### π Platinum Sponsor
|
|
63
|
+
|
|
64
|
+
<table>
|
|
65
|
+
<tr>
|
|
66
|
+
<td align="center"><a href="https://screenshotone.com/?ref=orpc" target="_blank" rel="noopener" title="ScreenshotOne.com"><img src="https://avatars.githubusercontent.com/u/97035603?v=4" width="279" alt="ScreenshotOne.com"/><br />ScreenshotOne.com</a></td>
|
|
67
|
+
</tr>
|
|
68
|
+
</table>
|
|
69
|
+
|
|
70
|
+
### π₯ Silver Sponsor
|
|
71
|
+
|
|
72
|
+
<table>
|
|
73
|
+
<tr>
|
|
74
|
+
<td align="center"><a href="https://misskey.io/?ref=orpc" target="_blank" rel="noopener" title="ζδΈγγ"><img src="https://avatars.githubusercontent.com/u/37681609?u=0dd4c7e4ba937cbb52b068c55914b1d8164dc0c7&v=4" width="209" alt="ζδΈγγ"/><br />ζδΈγγ</a></td>
|
|
75
|
+
</tr>
|
|
76
|
+
</table>
|
|
77
|
+
|
|
78
|
+
### Generous Sponsors
|
|
79
|
+
|
|
80
|
+
<table>
|
|
81
|
+
<tr>
|
|
82
|
+
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="noopener" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="167" alt="LN Markets"/><br />LN Markets</a></td>
|
|
83
|
+
</tr>
|
|
84
|
+
</table>
|
|
85
|
+
|
|
86
|
+
### Sponsors
|
|
87
|
+
|
|
88
|
+
<table>
|
|
89
|
+
<tr>
|
|
90
|
+
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="139" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
91
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="139" alt="nk"/><br />nk</a></td>
|
|
92
|
+
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="139" alt="supastarter"/><br />supastarter</a></td>
|
|
93
|
+
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="139" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
94
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="139" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
95
|
+
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
96
|
+
</tr>
|
|
97
|
+
<tr>
|
|
98
|
+
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="139" alt="David Cramer"/><br />David Cramer</a></td>
|
|
99
|
+
<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
|
+
<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
|
+
<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
|
+
<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>
|
|
104
|
+
</tr>
|
|
105
|
+
<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
|
+
<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
|
+
<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
|
+
</tr>
|
|
111
|
+
</table>
|
|
112
|
+
|
|
113
|
+
### Backers
|
|
114
|
+
|
|
115
|
+
<table>
|
|
116
|
+
<tr>
|
|
117
|
+
<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>
|
|
118
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
</tr>
|
|
125
|
+
<tr>
|
|
126
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
</tr>
|
|
134
|
+
<tr>
|
|
135
|
+
<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
|
+
<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
|
+
</tr>
|
|
139
|
+
</table>
|
|
140
|
+
|
|
141
|
+
### Past Sponsors
|
|
142
|
+
|
|
143
|
+
<p>
|
|
144
|
+
<a href="https://github.com/MrMaxie?ref=orpc" target="_blank" rel="noopener" title="Maxie"><img src="https://avatars.githubusercontent.com/u/3857836?u=5e6b57973d4385d655663ffdd836e487856f2984&v=4" width="32" height="32" alt="Maxie" /></a>
|
|
145
|
+
<a href="https://github.com/Stijn-Timmer?ref=orpc" target="_blank" rel="noopener" title="Stijn Timmer"><img src="https://avatars.githubusercontent.com/u/100147665?u=106b2c18e9c98a61861b4ee7fc100f5b9906a6c9&v=4" width="32" height="32" alt="Stijn Timmer" /></a>
|
|
146
|
+
<a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="noopener" title="γγγγγ¨γΌγ«γ
"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="32" height="32" alt="γγγγγ¨γΌγ«γ
" /></a>
|
|
147
|
+
<a href="https://github.com/zuplo?ref=orpc" target="_blank" rel="noopener" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="32" height="32" alt="Zuplo" /></a>
|
|
148
|
+
<a href="https://github.com/motopods?ref=orpc" target="_blank" rel="noopener" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?v=4" width="32" height="32" alt="motopods" /></a>
|
|
149
|
+
<a href="https://github.com/franciscohermida?ref=orpc" target="_blank" rel="noopener" title="Francisco Hermida"><img src="https://avatars.githubusercontent.com/u/483242?u=bbcbc80eb9d8781ff401f7dafc3b59cd7bea0561&v=4" width="32" height="32" alt="Francisco Hermida" /></a>
|
|
150
|
+
<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
|
+
<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
|
+
<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=24e8dd943cfc862aa284d858a023532c75071ade&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
154
|
+
<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
|
+
<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
|
+
<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>
|
|
157
|
+
<a href="https://github.com/cloudycotton?ref=orpc" target="_blank" rel="noopener" title="Saksham"><img src="https://avatars.githubusercontent.com/u/168998965?u=9b9634a5aed66a51c1b880663272725b00b92b14&v=4" width="32" height="32" alt="Saksham" /></a>
|
|
158
|
+
<a href="https://github.com/hrynevychroman?ref=orpc" target="_blank" rel="noopener" title="Roman Hrynevych"><img src="https://avatars.githubusercontent.com/u/82209198?u=1a1d111ab3d589855b9cc8a7fefb1b5c6a4fbbaf&v=4" width="32" height="32" alt="Roman Hrynevych" /></a>
|
|
159
|
+
<a href="https://github.com/rokitgg?ref=orpc" target="_blank" rel="noopener" title="rokitg"><img src="https://avatars.githubusercontent.com/u/125133357?u=06c74aefaa2236b06a2e5fba5a5c612339f45912&v=4" width="32" height="32" alt="rokitg" /></a>
|
|
160
|
+
<a href="https://github.com/omarkhatibgg?ref=orpc" target="_blank" rel="noopener" title="Omar Khatib"><img src="https://avatars.githubusercontent.com/u/9054278?u=afbba7331b85c51b8eee4130f5fd31b1017dc919&v=4" width="32" height="32" alt="Omar Khatib" /></a>
|
|
161
|
+
<a href="https://github.com/YuSabo90002?ref=orpc" target="_blank" rel="noopener" title="Yu-Sabo"><img src="https://avatars.githubusercontent.com/u/13120582?v=4" width="32" height="32" alt="Yu-Sabo" /></a>
|
|
162
|
+
<a href="https://github.com/bapspatil?ref=orpc" target="_blank" rel="noopener" title="Bapusaheb Patil"><img src="https://avatars.githubusercontent.com/u/16699418?u=6d9d8e0a64a6f91ca1c4d559c72d931172bdcbbd&v=4" width="32" height="32" alt="Bapusaheb Patil" /></a>
|
|
163
|
+
<a href="https://github.com/ripgrim?ref=orpc" target="_blank" rel="noopener" title="grim"><img src="https://avatars.githubusercontent.com/u/75869731?u=b17c42ec2309552fdb822a86b25a2f99146a4d72&v=4" width="32" height="32" alt="grim" /></a>
|
|
164
|
+
<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
|
+
<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
|
+
<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>
|
|
167
|
+
<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>
|
|
168
|
+
<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
|
+
<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
|
+
<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>
|
|
171
|
+
<a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="noopener" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&v=4" width="32" height="32" alt="Chen, Zhi-Yuan" /></a>
|
|
172
|
+
<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
|
+
<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
|
+
<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>
|
|
175
|
+
<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
|
+
<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
|
+
</p>
|
|
178
|
+
|
|
179
|
+
## References
|
|
180
|
+
|
|
181
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
182
|
+
|
|
183
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
184
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
185
|
+
|
|
186
|
+
## License
|
|
187
|
+
|
|
188
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '../index.mjs';
|
|
2
|
+
import '@orpc/shared';
|
|
3
|
+
|
|
4
|
+
interface MemoryPublisherOptions extends PublisherOptions {
|
|
5
|
+
/**
|
|
6
|
+
* Configuration for event replay support.
|
|
7
|
+
*
|
|
8
|
+
* When enabled, published events are temporarily stored so new
|
|
9
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
10
|
+
*
|
|
11
|
+
* @default { enabled: false }
|
|
12
|
+
*/
|
|
13
|
+
replay?: {
|
|
14
|
+
/**
|
|
15
|
+
* Whether event replay support is enabled.
|
|
16
|
+
*
|
|
17
|
+
* When enabled, published events are temporarily stored so new
|
|
18
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
19
|
+
*
|
|
20
|
+
* @default false
|
|
21
|
+
*/
|
|
22
|
+
enabled: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* How long (in seconds) to retain events for replay.
|
|
25
|
+
*
|
|
26
|
+
* Expired events are cleaned up lazily for performance reasons, so
|
|
27
|
+
* some events may remain available slightly longer than this period.
|
|
28
|
+
*
|
|
29
|
+
* @default 300 (5 min)
|
|
30
|
+
*/
|
|
31
|
+
seconds?: number;
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
declare class MemoryPublisher<T extends Record<string, object>> extends Publisher<T> {
|
|
35
|
+
private readonly listenersMap;
|
|
36
|
+
private readonly idGenerator;
|
|
37
|
+
private readonly eventsMap;
|
|
38
|
+
private readonly replayEnabled;
|
|
39
|
+
private readonly replaySeconds;
|
|
40
|
+
constructor({ replay, ...options }?: MemoryPublisherOptions);
|
|
41
|
+
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
42
|
+
protected subscribeListener<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
43
|
+
private lastCleanupTime;
|
|
44
|
+
private cleanup;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export { MemoryPublisher };
|
|
48
|
+
export type { MemoryPublisherOptions };
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '../index.js';
|
|
2
|
+
import '@orpc/shared';
|
|
3
|
+
|
|
4
|
+
interface MemoryPublisherOptions extends PublisherOptions {
|
|
5
|
+
/**
|
|
6
|
+
* Configuration for event replay support.
|
|
7
|
+
*
|
|
8
|
+
* When enabled, published events are temporarily stored so new
|
|
9
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
10
|
+
*
|
|
11
|
+
* @default { enabled: false }
|
|
12
|
+
*/
|
|
13
|
+
replay?: {
|
|
14
|
+
/**
|
|
15
|
+
* Whether event replay support is enabled.
|
|
16
|
+
*
|
|
17
|
+
* When enabled, published events are temporarily stored so new
|
|
18
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
19
|
+
*
|
|
20
|
+
* @default false
|
|
21
|
+
*/
|
|
22
|
+
enabled: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* How long (in seconds) to retain events for replay.
|
|
25
|
+
*
|
|
26
|
+
* Expired events are cleaned up lazily for performance reasons, so
|
|
27
|
+
* some events may remain available slightly longer than this period.
|
|
28
|
+
*
|
|
29
|
+
* @default 300 (5 min)
|
|
30
|
+
*/
|
|
31
|
+
seconds?: number;
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
declare class MemoryPublisher<T extends Record<string, object>> extends Publisher<T> {
|
|
35
|
+
private readonly listenersMap;
|
|
36
|
+
private readonly idGenerator;
|
|
37
|
+
private readonly eventsMap;
|
|
38
|
+
private readonly replayEnabled;
|
|
39
|
+
private readonly replaySeconds;
|
|
40
|
+
constructor({ replay, ...options }?: MemoryPublisherOptions);
|
|
41
|
+
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
42
|
+
protected subscribeListener<K extends keyof T & string>(event: K, listener: (payload: T[K]) => void, options?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
43
|
+
private lastCleanupTime;
|
|
44
|
+
private cleanup;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export { MemoryPublisher };
|
|
48
|
+
export type { MemoryPublisherOptions };
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { SequentialIdGenerator, once, compareSequentialIds } from '@orpc/shared';
|
|
2
|
+
import { unwrapEvent, withEventMeta, getEventMeta } from '@standardserver/core';
|
|
3
|
+
import { P as Publisher } from '../shared/publisher.BSQf8ybR.mjs';
|
|
4
|
+
|
|
5
|
+
class MemoryPublisher extends Publisher {
|
|
6
|
+
listenersMap = /* @__PURE__ */ new Map();
|
|
7
|
+
idGenerator = new SequentialIdGenerator();
|
|
8
|
+
eventsMap = /* @__PURE__ */ new Map();
|
|
9
|
+
replayEnabled;
|
|
10
|
+
replaySeconds;
|
|
11
|
+
constructor({ replay, ...options } = {}) {
|
|
12
|
+
super(options);
|
|
13
|
+
this.replayEnabled = replay?.enabled ?? false;
|
|
14
|
+
this.replaySeconds = replay?.seconds ?? 300;
|
|
15
|
+
}
|
|
16
|
+
async publish(event, payload) {
|
|
17
|
+
this.cleanup();
|
|
18
|
+
if (this.replayEnabled) {
|
|
19
|
+
const expiresAt = Date.now() + this.replaySeconds * 1e3;
|
|
20
|
+
let bucket = this.eventsMap.get(event);
|
|
21
|
+
if (!bucket) {
|
|
22
|
+
this.eventsMap.set(event, bucket = []);
|
|
23
|
+
}
|
|
24
|
+
const [original, meta] = unwrapEvent(payload);
|
|
25
|
+
payload = withEventMeta(original, { ...meta, id: this.idGenerator.generate() });
|
|
26
|
+
bucket.push({ expiresAt, payload });
|
|
27
|
+
}
|
|
28
|
+
const listeners = this.listenersMap.get(event);
|
|
29
|
+
listeners?.forEach((listener) => listener(payload));
|
|
30
|
+
}
|
|
31
|
+
async subscribeListener(event, listener, options) {
|
|
32
|
+
this.cleanup();
|
|
33
|
+
if (this.replayEnabled && options?.lastEventId !== void 0) {
|
|
34
|
+
const bucket = this.eventsMap.get(event);
|
|
35
|
+
if (bucket?.length) {
|
|
36
|
+
const startIdx = findReplayStartIndex(bucket, options.lastEventId);
|
|
37
|
+
for (let i = startIdx; i < bucket.length; i++) {
|
|
38
|
+
listener(bucket[i].payload);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
let listeners = this.listenersMap.get(event);
|
|
43
|
+
if (!listeners) {
|
|
44
|
+
this.listenersMap.set(event, listeners = []);
|
|
45
|
+
}
|
|
46
|
+
listeners.push(listener);
|
|
47
|
+
return once(async () => {
|
|
48
|
+
listeners.splice(listeners.indexOf(listener), 1);
|
|
49
|
+
if (listeners.length === 0) {
|
|
50
|
+
this.listenersMap.delete(event);
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
lastCleanupTime = 0;
|
|
55
|
+
cleanup() {
|
|
56
|
+
if (!this.replayEnabled) {
|
|
57
|
+
return;
|
|
58
|
+
}
|
|
59
|
+
const now = Date.now();
|
|
60
|
+
if (now - this.lastCleanupTime < this.replaySeconds * 1e3) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
this.lastCleanupTime = now;
|
|
64
|
+
for (const [key, bucket] of this.eventsMap) {
|
|
65
|
+
bucket.splice(0, findFirstUnexpiredIndex(bucket, now));
|
|
66
|
+
if (bucket.length === 0) {
|
|
67
|
+
this.eventsMap.delete(key);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
function findReplayStartIndex(bucket, lastEventId) {
|
|
73
|
+
let lo = 0;
|
|
74
|
+
let hi = bucket.length;
|
|
75
|
+
while (lo < hi) {
|
|
76
|
+
const mid = lo + hi >>> 1;
|
|
77
|
+
const id = getEventMeta(bucket[mid].payload)?.id;
|
|
78
|
+
if (id !== void 0 && compareSequentialIds(id, lastEventId) > 0) {
|
|
79
|
+
hi = mid;
|
|
80
|
+
} else {
|
|
81
|
+
lo = mid + 1;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return lo;
|
|
85
|
+
}
|
|
86
|
+
function findFirstUnexpiredIndex(bucket, now) {
|
|
87
|
+
let lo = 0;
|
|
88
|
+
let hi = bucket.length;
|
|
89
|
+
while (lo < hi) {
|
|
90
|
+
const mid = lo + hi >>> 1;
|
|
91
|
+
if (bucket[mid].expiresAt <= now) {
|
|
92
|
+
lo = mid + 1;
|
|
93
|
+
} else {
|
|
94
|
+
hi = mid;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
return lo;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export { MemoryPublisher };
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { RedisClientType } from 'redis';
|
|
2
|
+
import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '../index.mjs';
|
|
3
|
+
import { RPCSerializer } from '@orpc/client';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
|
|
6
|
+
interface RedisPublisherOptions extends PublisherOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Redis subscriber instance.
|
|
9
|
+
* Pub/Sub takes over the connection, so a client with subscriptions
|
|
10
|
+
* cannot execute commands and must use a dedicated connection.
|
|
11
|
+
*
|
|
12
|
+
* @default redis.duplicate()
|
|
13
|
+
*/
|
|
14
|
+
subscriber?: undefined | RedisClientType<any, any, any, any, any>;
|
|
15
|
+
/**
|
|
16
|
+
* The prefix to use for Redis keys.
|
|
17
|
+
*/
|
|
18
|
+
prefix?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Serializer for serialize and deserialize payloads.
|
|
21
|
+
*
|
|
22
|
+
* @default RPCSerializer
|
|
23
|
+
*/
|
|
24
|
+
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
25
|
+
/**
|
|
26
|
+
* Configuration for event replay support.
|
|
27
|
+
*
|
|
28
|
+
* When enabled, published events are temporarily stored so new
|
|
29
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
30
|
+
*
|
|
31
|
+
* @default { enabled: false }
|
|
32
|
+
*/
|
|
33
|
+
replay?: {
|
|
34
|
+
/**
|
|
35
|
+
* Whether event replay support is enabled.
|
|
36
|
+
*
|
|
37
|
+
* When enabled, published events are temporarily stored so new
|
|
38
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
39
|
+
*
|
|
40
|
+
* @default false
|
|
41
|
+
*/
|
|
42
|
+
enabled: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* How long (in seconds) to retain events for replay.
|
|
45
|
+
*
|
|
46
|
+
* Expired events are cleaned up lazily for performance reasons, so
|
|
47
|
+
* some events may remain available slightly longer than this period.
|
|
48
|
+
*
|
|
49
|
+
* @default 300 (5 min)
|
|
50
|
+
*/
|
|
51
|
+
seconds?: number;
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
declare class RedisPublisher<T extends Record<string, object>> extends Publisher<T> {
|
|
55
|
+
private readonly redis;
|
|
56
|
+
private readonly subscriber;
|
|
57
|
+
private readonly prefix;
|
|
58
|
+
private readonly serializer;
|
|
59
|
+
private readonly replayEnabled;
|
|
60
|
+
private readonly replaySeconds;
|
|
61
|
+
/**
|
|
62
|
+
* The exactness of the `XTRIM` command.
|
|
63
|
+
* Used for testing purpose.
|
|
64
|
+
*/
|
|
65
|
+
private readonly xTrimExactness;
|
|
66
|
+
constructor(redis: RedisClientType<any, any, any, any, any>, options?: RedisPublisherOptions);
|
|
67
|
+
private readonly firstPublishTimeMap;
|
|
68
|
+
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
69
|
+
protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
70
|
+
private serializePayload;
|
|
71
|
+
private deserializePayload;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export { RedisPublisher };
|
|
75
|
+
export type { RedisPublisherOptions };
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { RedisClientType } from 'redis';
|
|
2
|
+
import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '../index.js';
|
|
3
|
+
import { RPCSerializer } from '@orpc/client';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
|
|
6
|
+
interface RedisPublisherOptions extends PublisherOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Redis subscriber instance.
|
|
9
|
+
* Pub/Sub takes over the connection, so a client with subscriptions
|
|
10
|
+
* cannot execute commands and must use a dedicated connection.
|
|
11
|
+
*
|
|
12
|
+
* @default redis.duplicate()
|
|
13
|
+
*/
|
|
14
|
+
subscriber?: undefined | RedisClientType<any, any, any, any, any>;
|
|
15
|
+
/**
|
|
16
|
+
* The prefix to use for Redis keys.
|
|
17
|
+
*/
|
|
18
|
+
prefix?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Serializer for serialize and deserialize payloads.
|
|
21
|
+
*
|
|
22
|
+
* @default RPCSerializer
|
|
23
|
+
*/
|
|
24
|
+
serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
|
|
25
|
+
/**
|
|
26
|
+
* Configuration for event replay support.
|
|
27
|
+
*
|
|
28
|
+
* When enabled, published events are temporarily stored so new
|
|
29
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
30
|
+
*
|
|
31
|
+
* @default { enabled: false }
|
|
32
|
+
*/
|
|
33
|
+
replay?: {
|
|
34
|
+
/**
|
|
35
|
+
* Whether event replay support is enabled.
|
|
36
|
+
*
|
|
37
|
+
* When enabled, published events are temporarily stored so new
|
|
38
|
+
* subscribers can resume from a previous position using `lastEventId`.
|
|
39
|
+
*
|
|
40
|
+
* @default false
|
|
41
|
+
*/
|
|
42
|
+
enabled: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* How long (in seconds) to retain events for replay.
|
|
45
|
+
*
|
|
46
|
+
* Expired events are cleaned up lazily for performance reasons, so
|
|
47
|
+
* some events may remain available slightly longer than this period.
|
|
48
|
+
*
|
|
49
|
+
* @default 300 (5 min)
|
|
50
|
+
*/
|
|
51
|
+
seconds?: number;
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
declare class RedisPublisher<T extends Record<string, object>> extends Publisher<T> {
|
|
55
|
+
private readonly redis;
|
|
56
|
+
private readonly subscriber;
|
|
57
|
+
private readonly prefix;
|
|
58
|
+
private readonly serializer;
|
|
59
|
+
private readonly replayEnabled;
|
|
60
|
+
private readonly replaySeconds;
|
|
61
|
+
/**
|
|
62
|
+
* The exactness of the `XTRIM` command.
|
|
63
|
+
* Used for testing purpose.
|
|
64
|
+
*/
|
|
65
|
+
private readonly xTrimExactness;
|
|
66
|
+
constructor(redis: RedisClientType<any, any, any, any, any>, options?: RedisPublisherOptions);
|
|
67
|
+
private readonly firstPublishTimeMap;
|
|
68
|
+
publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
|
|
69
|
+
protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
|
|
70
|
+
private serializePayload;
|
|
71
|
+
private deserializePayload;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export { RedisPublisher };
|
|
75
|
+
export type { RedisPublisherOptions };
|