@orpc/pino 2.0.0-beta.22 → 2.0.0-beta.24

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 CHANGED
@@ -44,6 +44,7 @@ You can read the documentation [here](https://orpc.dev).
44
44
 
45
45
  - [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
46
46
  - [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
47
+ - [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation): Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api).
47
48
  - [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
48
49
 
49
50
  **Framework & ecosystem integrations**
@@ -114,6 +115,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
114
115
  </tr>
115
116
  <tr>
116
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&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
118
+ <td align="center"><a href="https://github.com/ellis-driscoll?ref=orpc" target="_blank" rel="noopener" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&amp;v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
117
119
  </tr>
118
120
  </table>
119
121
 
@@ -139,8 +141,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
139
141
  <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&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
140
142
  </tr>
141
143
  <tr>
144
+ <td align="center"><a href="https://github.com/guyariely?ref=orpc" target="_blank" rel="noopener" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&amp;v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
142
145
  <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&amp;v=4" width="119" alt="Alex"/><br />Alex</a></td>
143
- <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&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
146
+ <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=c5f2daf7ebece498e85c83367bb37b4e10e2649d&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
144
147
  </tr>
145
148
  </table>
146
149
 
package/dist/index.d.mts CHANGED
@@ -2,10 +2,26 @@ import { Logger } from 'pino';
2
2
  import { Context } from '@orpc/server';
3
3
  import { StandardHandlerPlugin, StandardHandlerRoutingInterceptorOptions, StandardHandlerOptions } from '@orpc/server/standard';
4
4
 
5
+ /**
6
+ * Context symbol under which the Pino logger is stored. Use it to provide a
7
+ * custom logger instance per request, e.g. when integrating with pino-http.
8
+ *
9
+ * @see {@link https://orpc.dev/docs/integrations/pino#providing-custom-logger-per-request | Pino Integration - Providing Custom Logger per Request}
10
+ */
5
11
  declare const LOGGER_CONTEXT_SYMBOL: unique symbol;
12
+ /**
13
+ * Context shape that carries the Pino logger injected by `PinoHandlerPlugin`.
14
+ *
15
+ * @see {@link https://orpc.dev/docs/integrations/pino#using-the-logger-in-your-code | Pino Integration - Using the Logger in Your Code}
16
+ */
6
17
  interface LoggerContext {
7
18
  [LOGGER_CONTEXT_SYMBOL]?: undefined | Logger;
8
19
  }
20
+ /**
21
+ * Retrieves the Pino logger from the oRPC context, if available.
22
+ *
23
+ * @see {@link https://orpc.dev/docs/integrations/pino#using-the-logger-in-your-code | Pino Integration - Using the Logger in Your Code}
24
+ */
9
25
  declare function getLogger(context: LoggerContext): Logger | undefined;
10
26
 
11
27
  interface PinoHandlerPluginOptions<T extends Context> {
@@ -35,6 +51,12 @@ interface PinoHandlerPluginOptions<T extends Context> {
35
51
  */
36
52
  logAbort?: boolean;
37
53
  }
54
+ /**
55
+ * Instruments an oRPC handler with Pino structured logging, request tracking,
56
+ * and error monitoring.
57
+ *
58
+ * @see {@link https://orpc.dev/docs/integrations/pino | Pino Integration}
59
+ */
38
60
  declare class PinoHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
39
61
  name: string;
40
62
  /**
package/dist/index.d.ts CHANGED
@@ -2,10 +2,26 @@ import { Logger } from 'pino';
2
2
  import { Context } from '@orpc/server';
3
3
  import { StandardHandlerPlugin, StandardHandlerRoutingInterceptorOptions, StandardHandlerOptions } from '@orpc/server/standard';
4
4
 
5
+ /**
6
+ * Context symbol under which the Pino logger is stored. Use it to provide a
7
+ * custom logger instance per request, e.g. when integrating with pino-http.
8
+ *
9
+ * @see {@link https://orpc.dev/docs/integrations/pino#providing-custom-logger-per-request | Pino Integration - Providing Custom Logger per Request}
10
+ */
5
11
  declare const LOGGER_CONTEXT_SYMBOL: unique symbol;
12
+ /**
13
+ * Context shape that carries the Pino logger injected by `PinoHandlerPlugin`.
14
+ *
15
+ * @see {@link https://orpc.dev/docs/integrations/pino#using-the-logger-in-your-code | Pino Integration - Using the Logger in Your Code}
16
+ */
6
17
  interface LoggerContext {
7
18
  [LOGGER_CONTEXT_SYMBOL]?: undefined | Logger;
8
19
  }
20
+ /**
21
+ * Retrieves the Pino logger from the oRPC context, if available.
22
+ *
23
+ * @see {@link https://orpc.dev/docs/integrations/pino#using-the-logger-in-your-code | Pino Integration - Using the Logger in Your Code}
24
+ */
9
25
  declare function getLogger(context: LoggerContext): Logger | undefined;
10
26
 
11
27
  interface PinoHandlerPluginOptions<T extends Context> {
@@ -35,6 +51,12 @@ interface PinoHandlerPluginOptions<T extends Context> {
35
51
  */
36
52
  logAbort?: boolean;
37
53
  }
54
+ /**
55
+ * Instruments an oRPC handler with Pino structured logging, request tracking,
56
+ * and error monitoring.
57
+ *
58
+ * @see {@link https://orpc.dev/docs/integrations/pino | Pino Integration}
59
+ */
38
60
  declare class PinoHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
39
61
  name: string;
40
62
  /**
package/dist/index.mjs CHANGED
@@ -16,7 +16,7 @@ class PinoHandlerPlugin {
16
16
  * - Logging interceptors should run after batch interceptors
17
17
  * so they log each individual request instead of the batch request.
18
18
  */
19
- before = ["~opentelemetry", "~batch"];
19
+ before = ["~opentelemetry", "~batch", "~hibernation"];
20
20
  logger;
21
21
  generateRequestId;
22
22
  logLifecycle;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/pino",
3
3
  "type": "module",
4
- "version": "2.0.0-beta.22",
4
+ "version": "2.0.0-beta.24",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.dev",
7
7
  "repository": {
@@ -29,10 +29,10 @@
29
29
  "pino": ">=10.1.0"
30
30
  },
31
31
  "dependencies": {
32
- "@standardserver/core": "^0.6.0",
33
- "@orpc/client": "2.0.0-beta.22",
34
- "@orpc/server": "2.0.0-beta.22",
35
- "@orpc/shared": "2.0.0-beta.22"
32
+ "@standardserver/core": "^0.7.1",
33
+ "@orpc/client": "2.0.0-beta.24",
34
+ "@orpc/shared": "2.0.0-beta.24",
35
+ "@orpc/server": "2.0.0-beta.24"
36
36
  },
37
37
  "devDependencies": {
38
38
  "pino": "^10.3.1"