npm - yedra - Versions diffs - 0.20.11 → 0.20.13 - Mend

yedra 0.20.11 → 0.20.13

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.

Files changed (81) hide show

package/dist/routing/rest.d.ts +2 -0
package/dist/routing/rest.js +2 -0
package/dist/routing/websocket.d.ts +1 -0
package/dist/routing/websocket.js +1 -0
package/dist/src/index.d.ts +9 -0
package/dist/src/index.js +7 -0
package/dist/src/lib.d.ts +10 -0
package/dist/src/lib.js +16 -0
package/dist/src/routing/app.d.ts +165 -0
package/dist/src/routing/app.js +537 -0
package/dist/src/routing/env.d.ts +4 -0
package/dist/src/routing/env.js +13 -0
package/dist/src/routing/errors.d.ts +50 -0
package/dist/src/routing/errors.js +64 -0
package/dist/src/routing/log.d.ts +22 -0
package/dist/src/routing/log.js +30 -0
package/dist/src/routing/path.d.ts +44 -0
package/dist/src/routing/path.js +110 -0
package/dist/src/routing/rest.d.ts +103 -0
package/dist/src/routing/rest.js +181 -0
package/dist/src/routing/websocket.d.ts +60 -0
package/dist/src/routing/websocket.js +132 -0
package/dist/src/schema-lib.d.ts +17 -0
package/dist/src/schema-lib.js +20 -0
package/dist/src/schema.d.ts +2 -0
package/dist/src/schema.js +4 -0
package/dist/src/util/counter.d.ts +7 -0
package/dist/src/util/counter.js +24 -0
package/dist/src/util/docs.d.ts +9 -0
package/dist/src/util/docs.js +57 -0
package/dist/src/util/security.d.ts +14 -0
package/dist/src/util/security.js +6 -0
package/dist/src/util/stream.d.ts +2 -0
package/dist/src/util/stream.js +7 -0
package/dist/src/validation/body.d.ts +46 -0
package/dist/src/validation/body.js +15 -0
package/dist/src/validation/boolean.d.ts +10 -0
package/dist/src/validation/boolean.js +27 -0
package/dist/src/validation/date.d.ts +11 -0
package/dist/src/validation/date.js +29 -0
package/dist/src/validation/doc.d.ts +10 -0
package/dist/src/validation/doc.js +22 -0
package/dist/src/validation/either.d.ts +15 -0
package/dist/src/validation/either.js +38 -0
package/dist/src/validation/enum.d.ts +19 -0
package/dist/src/validation/enum.js +44 -0
package/dist/src/validation/error.d.ts +21 -0
package/dist/src/validation/error.js +32 -0
package/dist/src/validation/integer.d.ts +23 -0
package/dist/src/validation/integer.js +64 -0
package/dist/src/validation/json.d.ts +12 -0
package/dist/src/validation/json.js +33 -0
package/dist/src/validation/lazy.d.ts +48 -0
package/dist/src/validation/lazy.js +78 -0
package/dist/src/validation/modifiable.d.ts +105 -0
package/dist/src/validation/modifiable.js +223 -0
package/dist/src/validation/none.d.ts +10 -0
package/dist/src/validation/none.js +14 -0
package/dist/src/validation/null.d.ts +10 -0
package/dist/src/validation/null.js +21 -0
package/dist/src/validation/number.d.ts +23 -0
package/dist/src/validation/number.js +58 -0
package/dist/src/validation/object.d.ts +38 -0
package/dist/src/validation/object.js +87 -0
package/dist/src/validation/raw.d.ts +13 -0
package/dist/src/validation/raw.js +21 -0
package/dist/src/validation/record.d.ts +16 -0
package/dist/src/validation/record.js +51 -0
package/dist/src/validation/schema.d.ts +35 -0
package/dist/src/validation/schema.js +76 -0
package/dist/src/validation/stream.d.ts +13 -0
package/dist/src/validation/stream.js +26 -0
package/dist/src/validation/string.d.ts +29 -0
package/dist/src/validation/string.js +51 -0
package/dist/src/validation/union.d.ts +16 -0
package/dist/src/validation/union.js +36 -0
package/dist/src/validation/unknown.d.ts +10 -0
package/dist/src/validation/unknown.js +13 -0
package/dist/src/validation/uuid.d.ts +11 -0
package/dist/src/validation/uuid.js +23 -0
package/package.json +3 -4

package/dist/routing/rest.d.ts CHANGED Viewed

@@ -6,9 +6,11 @@ import { type ObjectSchema } from '../validation/object.js';
 import type { Schema } from '../validation/schema.js';
 type ReqObject<Params, Query, Headers, Body> = {
     url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
     params: Params;
     query: Query;
     headers: Headers;
+    rawHeaders: Record<string, string>;
     body: Body;
 };
 type ResObject<Body> = Promise<{

package/dist/routing/rest.js CHANGED Viewed

@@ -84,12 +84,14 @@ class ConcreteRestEndpoint extends RestEndpoint {
         }
         return await this.options.do({
             url: req.url,
+            method: this._method,
             // biome-ignore lint/style/noNonNullAssertion: this is required to convince TypeScript that this is initialized
             params: parsedParams,
             // biome-ignore lint/style/noNonNullAssertion: this is required to convince TypeScript that this is initialized
             query: parsedQuery,
             // biome-ignore lint/style/noNonNullAssertion: this is required to convince TypeScript that this is initialized
             headers: parsedHeaders,
+            rawHeaders: req.headers,
             // biome-ignore lint/style/noNonNullAssertion: this is required to convince TypeScript that this is initialized
             body: parsedBody,
         });

package/dist/routing/websocket.d.ts CHANGED Viewed

@@ -44,6 +44,7 @@ type WebSocketOptions<Params extends Record<string, Schema<unknown>>, Query exte
         params: Typeof<ObjectSchema<Params>>;
         query: Typeof<ObjectSchema<Query>>;
         headers: Typeof<ObjectSchema<Headers>>;
+        rawHeaders: Record<string, string>;
     }) => Promise<void> | void;
 };
 export declare abstract class WsEndpoint {

package/dist/routing/websocket.js CHANGED Viewed

@@ -88,6 +88,7 @@ export class Ws extends WsEndpoint {
             params: parsedParams,
             query: parsedQuery,
             headers: parsedHeaders,
+            rawHeaders: headers,
         });
         return undefined;
     }

package/dist/src/index.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import * as y from './lib.js';
+export { y };
+export type { ConnectMiddleware } from './routing/app.js';
+export { Yedra } from './routing/app.js';
+export { BadRequestError, ConflictError, ForbiddenError, HttpError, NotFoundError, PaymentRequiredError, UnauthorizedError, } from './routing/errors.js';
+export { Delete, Get, Patch, Post, Put } from './routing/rest.js';
+export type { YedraWebSocket } from './routing/websocket.js';
+export { Ws } from './routing/websocket.js';
+export { SecurityScheme } from './util/security.js';

package/dist/src/index.js ADDED Viewed

@@ -0,0 +1,7 @@
+import * as y from './lib.js';
+export { y };
+export { Yedra } from './routing/app.js';
+export { BadRequestError, ConflictError, ForbiddenError, HttpError, NotFoundError, PaymentRequiredError, UnauthorizedError, } from './routing/errors.js';
+export { Delete, Get, Patch, Post, Put } from './routing/rest.js';
+export { Ws } from './routing/websocket.js';
+export { SecurityScheme } from './util/security.js';

package/dist/src/lib.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+export { BadRequestError, ConflictError, ForbiddenError, HttpError, NotFoundError, PaymentRequiredError, UnauthorizedError, } from './routing/errors.js';
+export { Log } from './routing/log.js';
+export * from './schema-lib.js';
+export declare const validatePath: (path: string) => void;
+export { parseEnv } from './routing/env.js';
+export { SecurityScheme } from './util/security.js';
+export { either } from './validation/either.js';
+export { json } from './validation/json.js';
+export { raw } from './validation/raw.js';
+export { stream } from './validation/stream.js';

package/dist/src/lib.js ADDED Viewed

@@ -0,0 +1,16 @@
+import { Path } from './routing/path.js';
+// routing
+export { BadRequestError, ConflictError, ForbiddenError, HttpError, NotFoundError, PaymentRequiredError, UnauthorizedError, } from './routing/errors.js';
+export { Log } from './routing/log.js';
+// validation (browser-safe, shared with yedra/schema)
+export * from './schema-lib.js';
+export const validatePath = (path) => {
+    new Path(path);
+};
+export { parseEnv } from './routing/env.js';
+export { SecurityScheme } from './util/security.js';
+// Node-only body types
+export { either } from './validation/either.js';
+export { json } from './validation/json.js';
+export { raw } from './validation/raw.js';
+export { stream } from './validation/stream.js';

package/dist/src/routing/app.d.ts ADDED Viewed

@@ -0,0 +1,165 @@
+import type { IncomingMessage, Server, ServerResponse } from 'node:http';
+import { WebSocketServer } from 'ws';
+import { Counter } from '../util/counter.js';
+import { Path } from './path.js';
+import { RestEndpoint } from './rest.js';
+import { WsEndpoint } from './websocket.js';
+declare class Context {
+    private readonly server;
+    private readonly wss;
+    private readonly counter;
+    readonly docs: object;
+    constructor(server: Server, wss: WebSocketServer, counter: Counter, docs: object);
+    stop(): Promise<void>;
+}
+type ServeFile = {
+    data: Buffer;
+    mime: string;
+    etag: string;
+    cacheControl: string;
+};
+type ServeResponse = {
+    status?: number;
+    body: Uint8Array | string;
+    headers?: Record<string, string>;
+};
+type ServeFallback = (req: {
+    href: string;
+}) => ServeResponse | Promise<ServeResponse>;
+type ServeConfig = {
+    dir: string;
+    fallback?: string | ServeFallback;
+    /**
+     * Files matching `pattern` are served with `Cache-Control: public,
+     * max-age=<maxAge>, immutable`. Intended for content-addressed assets
+     * (e.g. `app.abc12345.js`) whose URL changes when the content changes.
+     * Never matches the fallback file.
+     */
+    immutable?: {
+        pattern: RegExp;
+        maxAge: number;
+    };
+};
+type ServeData = {
+    files: Map<string, ServeFile>;
+    fallback: ServeFallback | undefined;
+};
+type DocsData = {
+    /**
+     * The title of your API.
+     */
+    title: string;
+    /**
+     * The description of your API.
+     */
+    description: string;
+    /**
+     * The current version of your API.
+     */
+    version: string;
+    /**
+     * The list of servers your API is reachable under.
+     */
+    servers?: {
+        description: string;
+        url: string;
+    }[];
+};
+export type ConnectMiddleware = (req: IncomingMessage, res: ServerResponse, next: () => void) => void;
+type RestRoute = {
+    path: Path;
+    endpoint: RestEndpoint;
+};
+type WsRoute = {
+    path: Path;
+    endpoint: WsEndpoint;
+};
+declare class BuiltApp {
+    private serveData;
+    private docs;
+    private generatedDocs;
+    private connectMiddlewares;
+    private quiet;
+    private restRoutes;
+    private wsRoutes;
+    private requestData;
+    constructor(options: {
+        serveData: ServeData;
+        docs: object;
+        connectMiddlewares: ConnectMiddleware[];
+        quiet: boolean;
+        restRoutes: RestRoute[];
+        wsRoutes: WsRoute[];
+    });
+    private static middlewareNext;
+    handle(req: IncomingMessage, res: ServerResponse): void;
+    private performRequest;
+    private static errorResponse;
+    private matchRestRoute;
+    private track;
+    metrics(): string;
+    listen(port: number, options?: {
+        tls?: {
+            key: string;
+            cert: string;
+        };
+        metrics?: {
+            port: number;
+            path: string;
+            get?: () => Promise<string> | string;
+        };
+    }): Context;
+    private matchWsRoute;
+}
+export declare class Yedra {
+    private restRoutes;
+    private wsRoutes;
+    use(path: string, endpoint: RestEndpoint | WsEndpoint | Yedra): Yedra;
+    private generateDocs;
+    private static loadServe;
+    build(options?: {
+        /**
+         * Configuration for the `/openapi.json` endpoint, which generates
+         * OpenAPI documentation.
+         */
+        docs?: DocsData;
+        quiet?: boolean;
+        serve?: ServeConfig;
+        /**
+         * Add Express/Connect compatible middleware.
+         */
+        connectMiddlewares?: ConnectMiddleware[];
+    }): Promise<BuiltApp>;
+    listen(port: number, options?: {
+        tls?: {
+            key: string;
+            cert: string;
+        };
+        metrics?: {
+            port: number;
+            path: string;
+            get?: () => Promise<string> | string;
+        };
+        /**
+         * Configuration for the `/openapi.json` endpoint, which generates
+         * OpenAPI documentation.
+         */
+        docs?: DocsData;
+        serve?: ServeConfig;
+        /**
+         * Prevents all normal output from Yedra. Mostly useful for tests.
+         */
+        quiet?: boolean;
+        /**
+         * Add Express/Connect compatible middleware.
+         */
+        connectMiddlewares?: ConnectMiddleware[];
+    }): Promise<Context>;
+}
+export {};
+/**
+ * TODO: how do we add OpenTelemetry instrumentation here?
+ * We need two things:
+ * 1. Start active span for each incoming request, and end after response is sent.
+ * 2. Extract context from incoming requests to propagate traces.
+ */