routup 3.2.0 → 4.0.0

package/dist/path/type.d.ts

@@ -1,7 +1,7 @@
-import type { ParseOptions, TokensToRegexpOptions } from 'path-to-regexp';
-export type PathMatcherOptions = TokensToRegexpOptions & ParseOptions;
+import type { ParseOptions, PathToRegexpOptions } from 'path-to-regexp';
+export type PathMatcherOptions = PathToRegexpOptions & ParseOptions;
 export type PathMatcherExecResult = {
     path: string;
     params: Record<string, any>;
 };
-export type Path = string | RegExp;
+export type Path = string;

package/dist/request/helpers/env.d.ts

@@ -1,6 +1,6 @@
 import type { Request } from '../types';
-export declare function setRequestEnv(req: Request, key: string, value: unknown): void;
-export declare function setRequestEnv(req: Request, record: Record<string, any>, append?: boolean): void;
+export declare function setRequestEnv(req: Request, key: string | symbol, value: unknown): void;
+export declare function setRequestEnv(req: Request, record: Record<string | symbol, any>, append?: boolean): void;
 export declare function useRequestEnv(req: Request): Record<string, any>;
-export declare function useRequestEnv(req: Request, key: string): unknown | undefined;
-export declare function unsetRequestEnv(req: Request, key: string): void;
+export declare function useRequestEnv(req: Request, key: PropertyKey): unknown | undefined;
+export declare function unsetRequestEnv(req: Request, key: PropertyKey): void;

package/dist/request/helpers/header-accept-encoding.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { IncomingMessage } from 'node:http';
 export declare function getRequestAcceptableEncodings(req: IncomingMessage): string[];
 export declare function getRequestAcceptableEncoding(req: IncomingMessage, input: string | string[]): string | undefined;

package/dist/request/helpers/header.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { IncomingHttpHeaders } from 'node:http';
 import type { Request } from '../types';
 export declare function getRequestHeader<K extends keyof IncomingHttpHeaders>(req: Request, name: K): IncomingHttpHeaders[K];

package/dist/request/helpers/http2.d.ts

@@ -0,0 +1,2 @@
+import type { Request } from '../types';
+export declare function isRequestHTTP2(req: Request): boolean;

package/dist/request/helpers/index.d.ts

@@ -7,6 +7,7 @@ export * from './header-accept-encoding';
 export * from './header-accept-language';
 export * from './header-content-type';
 export * from './hostname';
+export * from './http2';
 export * from './ip';
 export * from './mount-path';
 export * from './negotiator';

package/dist/request/module.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { IncomingMessage } from 'node:http';
 import type { RequestCreateContext } from './types';
 export declare function createRequest(context: RequestCreateContext): IncomingMessage;

package/dist/request/types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { IncomingMessage } from 'node:http';
 import type { NodeReadableStream, WebReadableStream } from '../types';
 export type RequestBody = null | Iterable<any> | AsyncIterable<any> | NodeReadableStream | WebReadableStream;

package/dist/response/helpers/event-stream/factory.d.ts

@@ -0,0 +1,3 @@
+import type { Response } from '../../types';
+import { EventStream } from './module';
+export declare function createEventStream(response: Response): EventStream;

package/dist/response/helpers/event-stream/index.d.ts

@@ -0,0 +1,2 @@
+export * from './factory';
+export * from './module';

package/dist/response/helpers/event-stream/module.d.ts

@@ -0,0 +1,17 @@
+import { PassThrough } from 'readable-stream';
+import type { Response } from '../../types';
+import type { EventStreamListener, EventStreamMessage } from './types';
+export declare class EventStream {
+    protected response: Response;
+    protected passThrough: PassThrough;
+    protected flushed: boolean;
+    protected eventHandlers: Record<string, EventStreamListener[]>;
+    constructor(response: Response);
+    protected open(): void;
+    write(message: EventStreamMessage): void;
+    write(message: string): void;
+    end(): void;
+    on(event: 'close', listener: EventStreamListener): void;
+    on(event: 'error', listener: EventStreamListener): void;
+    protected emit(event: string, ...args: any[]): void;
+}

package/dist/response/helpers/event-stream/types.d.ts

@@ -0,0 +1,24 @@
+/**
+ * https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format
+ */
+export type EventStreamMessage = {
+    /**
+     * The event ID to set the EventSource object's last event ID value.
+     */
+    id?: string;
+    /**
+     * The reconnection time.
+     * If the connection to the server is lost, the browser will wait for the specified time before attempting to reconnect.
+     * This must be an integer, specifying the reconnection time in milliseconds.
+     */
+    retry?: number;
+    /**
+     * The data field for the message.
+     */
+    data: string;
+    /**
+     * A string identifying the type of event described.
+     */
+    event?: string;
+};
+export type EventStreamListener<T = any> = (err: Error | null, data: T) => void | Promise<void>;

package/dist/response/helpers/event-stream/utils.d.ts

@@ -0,0 +1,2 @@
+import type { EventStreamMessage } from './types';
+export declare function serializeEventStreamMessage(message: EventStreamMessage): string;

package/dist/response/helpers/gone.d.ts

@@ -1,2 +1,3 @@
 import type { Response } from '../types';
 export declare function isResponseGone(res: Response): any;
+export declare function setResponseGone(res: Response, value: boolean): void;

package/dist/response/helpers/header.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OutgoingHttpHeader } from 'node:http';
 import type { Response } from '../types';
 export declare function appendResponseHeader(res: Response, name: string, value: OutgoingHttpHeader): void;

package/dist/response/helpers/index.d.ts

@@ -1,4 +1,5 @@
 export * from './cache';
+export * from './event-stream';
 export * from './gone';
 export * from './header';
 export * from './header-attachment';

package/dist/response/types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ServerResponse } from 'node:http';
 export interface Response extends ServerResponse {
 }

package/dist/types.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { Readable as NodeReadable } from 'node:stream';
 import type { Readable } from 'readable-stream';
 import type { ReadableStream } from 'stream/web';

package/dist/utils/etag/module.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Buffer } from 'buffer';
 import { type Stats } from 'node:fs';
 import type { EtagOptions } from './type';

package/dist/utils/etag/type.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export type EtagOptions = {
     /**
      * Create a weak ETag?

package/dist/utils/object.d.ts

@@ -1 +1,3 @@
 export declare function isObject(item: unknown): item is Record<string, any>;
+export declare function setProperty(record: Record<PropertyKey, any>, property: PropertyKey, value: any): void;
+export declare function getProperty<T = any>(req: Record<PropertyKey, any>, property: PropertyKey): T;

package/dist/utils/stream.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { ReadableStream as WebReadableStream } from 'stream/web';
 import type { Readable as NodeReadable } from 'node:stream';
 import type { Readable } from 'readable-stream';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "routup",
-    "version": "3.2.0",
+    "version": "4.0.0",
     "description": "Routup is a minimalistic http based routing framework.",
     "exports": {
         "./package.json": "./package.json",
@@ -52,35 +52,35 @@
     "dependencies": {
         "@ebec/http": "^2.3.0",
         "buffer": "^6.0.3",
-        "mime-explorer": "^1.0.0",
+        "mime-explorer": "^1.1.0",
         "negotiator": "^0.6.3",
-        "path-to-regexp": "^6.2.1",
+        "path-to-regexp": "^7.0.0",
         "proxy-addr": "^2.0.7",
-        "readable-stream": "^4.4.2",
-        "smob": "^1.4.1",
+        "readable-stream": "^4.5.2",
+        "smob": "^1.5.0",
         "uncrypto": "^0.1.3"
     },
     "devDependencies": {
-        "@rollup/plugin-commonjs": "^25.0.7",
+        "@rollup/plugin-commonjs": "^26.0.1",
         "@rollup/plugin-node-resolve": "^15.2.3",
-        "@swc/core": "^1.3.96",
-        "@swc/jest": "^0.2.29",
-        "@tada5hi/commitlint-config": "^1.1.3",
-        "@tada5hi/eslint-config-typescript": "^1.2.6",
-        "@tada5hi/semantic-release": "^0.3.0",
-        "@tada5hi/tsconfig": "^0.5.0",
-        "@types/jest": "^29.5.7",
-        "@types/negotiator": "^0.6.2",
-        "@types/node": "^20.8.10",
-        "@types/proxy-addr": "^2.0.2",
-        "@types/readable-stream": "^4.0.4",
-        "@types/supertest": "^2.0.15",
+        "@swc/core": "^1.6.5",
+        "@swc/jest": "^0.2.36",
+        "@tada5hi/commitlint-config": "^1.2.1",
+        "@tada5hi/eslint-config-typescript": "^1.2.11",
+        "@tada5hi/semantic-release": "^0.3.1",
+        "@tada5hi/tsconfig": "^0.5.1",
+        "@types/jest": "^29.5.12",
+        "@types/negotiator": "^0.6.3",
+        "@types/node": "^20.12.2",
+        "@types/proxy-addr": "^2.0.3",
+        "@types/readable-stream": "^4.0.14",
+        "@types/supertest": "^6.0.2",
         "cross-env": "^7.0.3",
         "jest": "^29.7.0",
-        "rimraf": "^5.0.5",
-        "rollup": "^4.3.0",
-        "semantic-release": "^22.0.7",
-        "supertest": "^6.3.3",
-        "typescript": "5.2.2"
+        "rimraf": "^5.0.7",
+        "rollup": "^4.18.0",
+        "semantic-release": "^22.0.12",
+        "supertest": "^7.0.0",
+        "typescript": "5.5.2"
     }
 }