@orpc/server 0.0.0-next.a2e4a58 → 0.0.0-next.a320605

package/dist/hibernation/index.d.mts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.gqRxT-yN.mjs';
+import { HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator, HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.CYNGeoCm.mjs';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function encodeHibernationRPCEvent(id: string, payload: unknown, options?: EncodeHibernationRPCEventOptions): string;
+
+interface HibernationPluginContext {
+    iterator?: HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };
+export type { EncodeHibernationRPCEventOptions, HibernationPluginContext };

package/dist/hibernation/index.d.ts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.Bmh5xd4n.js';
+import { HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator, HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.CYNGeoCm.js';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function encodeHibernationRPCEvent(id: string, payload: unknown, options?: EncodeHibernationRPCEventOptions): string;
+
+interface HibernationPluginContext {
+    iterator?: HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };
+export type { EncodeHibernationRPCEventOptions, HibernationPluginContext };

package/dist/hibernation/index.mjs

@@ -0,0 +1,65 @@
+import { toORPCError } from '@orpc/client';
+import { StandardRPCJsonSerializer } from '@orpc/client/standard';
+import { stringifyJSON } from '@orpc/shared';
+import { getEventMeta, HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator } from '@orpc/standard-server';
+import { MessageType } from '@orpc/standard-server-peer';
+
+function encodeHibernationRPCEvent(id, payload, options = {}) {
+  const { event = "message", ...rest } = options;
+  const serializer = new StandardRPCJsonSerializer(rest);
+  const data = event === "error" ? toORPCError(payload).toJSON() : payload;
+  const [json, meta] = serializer.serialize(data);
+  return stringifyJSON({
+    i: id,
+    t: MessageType.EVENT_ITERATOR,
+    p: {
+      e: event,
+      d: { json, meta: meta.length > 0 ? meta : void 0 },
+      m: getEventMeta(payload)
+    }
+  });
+}
+
+class HibernationPlugin {
+  CONTEXT_SYMBOL = Symbol("ORPC_HIBERNATION_CONTEXT");
+  order = 2e6;
+  // make sure execute after the batch plugin
+  init(options, _router) {
+    options.interceptors ??= [];
+    options.clientInterceptors ??= [];
+    options.interceptors.unshift(async (options2) => {
+      const hibernationContext = {};
+      const result = await options2.next({
+        ...options2,
+        context: {
+          ...options2.context,
+          [this.CONTEXT_SYMBOL]: hibernationContext
+        }
+      });
+      if (!result.matched || !hibernationContext.iterator) {
+        return result;
+      }
+      return {
+        ...result,
+        response: {
+          ...result.response,
+          body: hibernationContext.iterator
+        }
+      };
+    });
+    options.clientInterceptors.unshift(async (options2) => {
+      const hibernationContext = options2.context[this.CONTEXT_SYMBOL];
+      if (!hibernationContext) {
+        throw new TypeError("[HibernationPlugin] Hibernation context has been corrupted or modified by another plugin or interceptor");
+      }
+      const output = await options2.next();
+      if (output instanceof HibernationEventIterator) {
+        hibernationContext.iterator = output;
+      }
+      return output;
+    });
+  }
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };