@tramvai/tokens-server-private 2.134.0 → 2.139.2

package/lib/index.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import type { Server } from 'http';
 import type { FastifyError, FastifyInstance, FastifyReply, FastifyRequest as OriginalFastifyRequest } from 'fastify';
 import type { Papi } from '@tramvai/papi';
+import type { Duplex } from 'stream';
 type FastifyRequest = OriginalFastifyRequest & {
     cookies: Record<string, string>;
 };
@@ -21,6 +23,27 @@ export declare const FASTIFY_REQUEST: OriginalFastifyRequest<import("fastify").R
 export declare const FASTIFY_RESPONSE: FastifyReply<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown> & {
     __type?: "base token" | undefined;
 };
+/**
+ * @description
+ * Read/Write stream, will be passed to FASTIFY_RESPONSE, method .send()
+ * https://lirantal.com/blog/avoid-fastify-reply-raw-and-reply-hijack-despite-being-a-powerful-http-streams-tool/
+ */
+export declare const SERVER_RESPONSE_STREAM: Duplex & {
+    __type?: "base token" | undefined;
+};
+export type ServerResponseTask = () => Promise<any>;
+export interface ServerResponseTaskManager {
+    push(task: ServerResponseTask): void;
+    processQueue(): void;
+    closeQueue(): Promise<any>;
+}
+/**
+ * @description
+ * Response stream to client will not be closed before all tasks in queue will be processed
+ */
+export declare const SERVER_RESPONSE_TASK_MANAGER: ServerResponseTaskManager & {
+    __type?: "base token" | undefined;
+};
 /**
  * @description
  * Creates new server instance

package/lib/index.es.js

@@ -10,6 +10,17 @@ const FASTIFY_REQUEST = createToken('fastify request');
  * Direct reference to response object
  */
 const FASTIFY_RESPONSE = createToken('fastify response');
+/**
+ * @description
+ * Read/Write stream, will be passed to FASTIFY_RESPONSE, method .send()
+ * https://lirantal.com/blog/avoid-fastify-reply-raw-and-reply-hijack-despite-being-a-powerful-http-streams-tool/
+ */
+const SERVER_RESPONSE_STREAM = createToken('tramvai server response stream');
+/**
+ * @description
+ * Response stream to client will not be closed before all tasks in queue will be processed
+ */
+const SERVER_RESPONSE_TASK_MANAGER = createToken('tramvai server response task manager');
 /**
  * @description
  * Creates new server instance
@@ -89,4 +100,4 @@ const PAPI_FASTIFY_INIT_TOKEN = createToken('papi fastify init', {
     multi: true,
 });
 
-export { EARLY_HINTS_MANAGER_TOKEN, FASTIFY_REQUEST, FASTIFY_RESPONSE, PAPI_EXECUTOR, PAPI_FASTIFY_INIT_TOKEN, SERVER_FACTORY_TOKEN, UTILITY_SERVER_TOKEN, UTILITY_WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_AFTER_ERROR_TOKEN, WEB_FASTIFY_APP_AFTER_INIT_TOKEN, WEB_FASTIFY_APP_BEFORE_ERROR_TOKEN, WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_INIT_TOKEN, WEB_FASTIFY_APP_LIMITER_TOKEN, WEB_FASTIFY_APP_METRICS_TOKEN, WEB_FASTIFY_APP_TOKEN };
+export { EARLY_HINTS_MANAGER_TOKEN, FASTIFY_REQUEST, FASTIFY_RESPONSE, PAPI_EXECUTOR, PAPI_FASTIFY_INIT_TOKEN, SERVER_FACTORY_TOKEN, SERVER_RESPONSE_STREAM, SERVER_RESPONSE_TASK_MANAGER, UTILITY_SERVER_TOKEN, UTILITY_WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_AFTER_ERROR_TOKEN, WEB_FASTIFY_APP_AFTER_INIT_TOKEN, WEB_FASTIFY_APP_BEFORE_ERROR_TOKEN, WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_INIT_TOKEN, WEB_FASTIFY_APP_LIMITER_TOKEN, WEB_FASTIFY_APP_METRICS_TOKEN, WEB_FASTIFY_APP_TOKEN };

package/lib/index.js

@@ -14,6 +14,17 @@ const FASTIFY_REQUEST = dippy.createToken('fastify request');
  * Direct reference to response object
  */
 const FASTIFY_RESPONSE = dippy.createToken('fastify response');
+/**
+ * @description
+ * Read/Write stream, will be passed to FASTIFY_RESPONSE, method .send()
+ * https://lirantal.com/blog/avoid-fastify-reply-raw-and-reply-hijack-despite-being-a-powerful-http-streams-tool/
+ */
+const SERVER_RESPONSE_STREAM = dippy.createToken('tramvai server response stream');
+/**
+ * @description
+ * Response stream to client will not be closed before all tasks in queue will be processed
+ */
+const SERVER_RESPONSE_TASK_MANAGER = dippy.createToken('tramvai server response task manager');
 /**
  * @description
  * Creates new server instance
@@ -99,6 +110,8 @@ exports.FASTIFY_RESPONSE = FASTIFY_RESPONSE;
 exports.PAPI_EXECUTOR = PAPI_EXECUTOR;
 exports.PAPI_FASTIFY_INIT_TOKEN = PAPI_FASTIFY_INIT_TOKEN;
 exports.SERVER_FACTORY_TOKEN = SERVER_FACTORY_TOKEN;
+exports.SERVER_RESPONSE_STREAM = SERVER_RESPONSE_STREAM;
+exports.SERVER_RESPONSE_TASK_MANAGER = SERVER_RESPONSE_TASK_MANAGER;
 exports.UTILITY_SERVER_TOKEN = UTILITY_SERVER_TOKEN;
 exports.UTILITY_WEB_FASTIFY_APP_TOKEN = UTILITY_WEB_FASTIFY_APP_TOKEN;
 exports.WEB_FASTIFY_APP_AFTER_ERROR_TOKEN = WEB_FASTIFY_APP_AFTER_ERROR_TOKEN;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/tokens-server-private",
-  "version": "2.134.0",
+  "version": "2.139.2",
   "description": "Tramvai private tokens for @tramvai/module-server",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -18,7 +18,7 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tramvai/papi": "2.134.0"
+    "@tramvai/papi": "2.139.2"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.8.15",