@orpc/evlog 2.0.0-beta.23 → 2.0.0-beta.24

package/README.md

@@ -44,6 +44,7 @@ You can read the documentation [here](https://orpc.dev).
 
 - [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
 - [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
+- [@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).
 - [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
 
 **Framework & ecosystem integrations**
@@ -114,6 +115,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   </tr>
   <tr>
    <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>
+   <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>
   </tr>
 </table>
 
@@ -139,8 +141,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <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>
   </tr>
   <tr>
+   <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>
    <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>
-   <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>
+   <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>
   </tr>
 </table>
 

package/dist/adapters/node.d.mts

@@ -2,6 +2,12 @@ import { StandardRequest } from '@standardserver/core';
 import { RequestLogger } from 'evlog';
 import { FrameworkIntegrationSpec } from 'evlog/toolkit';
 
+/**
+ * Creates an AsyncLocalStorage-backed logger store. Pass `storage` to
+ * `EvlogHandlerPlugin` and call `useLogger` inside procedures to access the request logger.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#using-the-logger-in-your-code | Evlog Integration - Using the Logger in Your Code}
+ */
 declare function createLoggerStorage(): {
     storage: FrameworkIntegrationSpec<{
         request: StandardRequest;

package/dist/adapters/node.d.ts

@@ -2,6 +2,12 @@ import { StandardRequest } from '@standardserver/core';
 import { RequestLogger } from 'evlog';
 import { FrameworkIntegrationSpec } from 'evlog/toolkit';
 
+/**
+ * Creates an AsyncLocalStorage-backed logger store. Pass `storage` to
+ * `EvlogHandlerPlugin` and call `useLogger` inside procedures to access the request logger.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#using-the-logger-in-your-code | Evlog Integration - Using the Logger in Your Code}
+ */
 declare function createLoggerStorage(): {
     storage: FrameworkIntegrationSpec<{
         request: StandardRequest;

package/dist/index.d.mts

@@ -5,9 +5,19 @@ import { StandardRequest } from '@standardserver/core';
 import { BaseEvlogOptions, FrameworkIntegrationSpec } from 'evlog/toolkit';
 
 declare const LOGGER_CONTEXT_SYMBOL: unique symbol;
+/**
+ * Context shape that carries the Evlog request logger injected by `EvlogHandlerPlugin`.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#without-asynclocalstorage | Evlog Integration - Without AsyncLocalStorage}
+ */
 interface LoggerContext {
     [LOGGER_CONTEXT_SYMBOL]?: undefined | RequestLogger;
 }
+/**
+ * Retrieves the Evlog request logger from the oRPC context, if available.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#without-asynclocalstorage | Evlog Integration - Without AsyncLocalStorage}
+ */
 declare function getLogger(context: LoggerContext): RequestLogger | undefined;
 
 interface EvlogHandlerPluginOptions<_T extends Context> extends BaseEvlogOptions {
@@ -24,6 +34,12 @@ interface EvlogHandlerPluginOptions<_T extends Context> extends BaseEvlogOptions
      */
     logAbort?: boolean;
 }
+/**
+ * Instruments an oRPC handler with Evlog structured logging, request tracking,
+ * and error monitoring.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog | Evlog Integration}
+ */
 declare class EvlogHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
     name: string;
     /**

package/dist/index.d.ts

@@ -5,9 +5,19 @@ import { StandardRequest } from '@standardserver/core';
 import { BaseEvlogOptions, FrameworkIntegrationSpec } from 'evlog/toolkit';
 
 declare const LOGGER_CONTEXT_SYMBOL: unique symbol;
+/**
+ * Context shape that carries the Evlog request logger injected by `EvlogHandlerPlugin`.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#without-asynclocalstorage | Evlog Integration - Without AsyncLocalStorage}
+ */
 interface LoggerContext {
     [LOGGER_CONTEXT_SYMBOL]?: undefined | RequestLogger;
 }
+/**
+ * Retrieves the Evlog request logger from the oRPC context, if available.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog#without-asynclocalstorage | Evlog Integration - Without AsyncLocalStorage}
+ */
 declare function getLogger(context: LoggerContext): RequestLogger | undefined;
 
 interface EvlogHandlerPluginOptions<_T extends Context> extends BaseEvlogOptions {
@@ -24,6 +34,12 @@ interface EvlogHandlerPluginOptions<_T extends Context> extends BaseEvlogOptions
      */
     logAbort?: boolean;
 }
+/**
+ * Instruments an oRPC handler with Evlog structured logging, request tracking,
+ * and error monitoring.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/evlog | Evlog Integration}
+ */
 declare class EvlogHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
     name: string;
     /**

package/dist/index.mjs

@@ -16,7 +16,7 @@ class EvlogHandlerPlugin {
    * - Logging interceptors should run after batch interceptors
    *   so they log each individual request instead of the batch request.
    */
-  before = ["~opentelemetry", "~batch"];
+  before = ["~opentelemetry", "~batch", "~hibernation"];
   logAbort;
   integration;
   evlogOptions;
@@ -60,8 +60,8 @@ class EvlogHandlerPlugin {
               response: {
                 ...result.response,
                 /**
-                 * @warning
-                 * Remember use `override` for AsyncIteratorObject to remain other special properties
+                 * @remarks
+                 * **Warning**: Remember use `override` for AsyncIteratorObject to remain other special properties
                  */
                 body: override(result.response.body, wrapAsyncIteratorPreservingEventMeta(result.response.body, {
                   runWith,
@@ -82,8 +82,8 @@ class EvlogHandlerPlugin {
               response: {
                 ...result.response,
                 /**
-                 * @warning
-                 * Remember use `override` for ReadableStream to remain other special properties
+                 * @remarks
+                 * **Warning**: Remember use `override` for ReadableStream to remain other special properties
                  */
                 body: override(result.response.body, wrapReadableStream(result.response.body, {
                   runWith,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/evlog",
   "type": "module",
-  "version": "2.0.0-beta.23",
+  "version": "2.0.0-beta.24",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -34,10 +34,10 @@
     "evlog": ">=2.18.1"
   },
   "dependencies": {
-    "@standardserver/core": "^0.6.0",
-    "@orpc/client": "2.0.0-beta.23",
-    "@orpc/shared": "2.0.0-beta.23",
-    "@orpc/server": "2.0.0-beta.23"
+    "@standardserver/core": "^0.7.1",
+    "@orpc/client": "2.0.0-beta.24",
+    "@orpc/shared": "2.0.0-beta.24",
+    "@orpc/server": "2.0.0-beta.24"
   },
   "devDependencies": {
     "evlog": "^2.22.3"