@orion-js/http 4.3.2 → 4.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Orionjs Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/errors.d.ts

@@ -0,0 +1,5 @@
+import express from 'express';
+type onErrorFunction = (req: express.Request, res: express.Response, error: any) => Promise<void>;
+export declare const onError: onErrorFunction;
+export declare const setOnError: (onErrorFunc: onErrorFunction) => void;
+export {};

package/dist/index.d.ts

@@ -1,110 +1,10 @@
 import express, { RequestHandler } from 'express';
-export { default as express } from 'express';
-import { OptionsJson, OptionsText, OptionsUrlencoded } from 'body-parser';
-import { Schema, InferSchemaType, SchemaFieldType } from '@orion-js/schema';
-
-type onErrorFunction = (req: express.Request, res: express.Response, error: any) => Promise<void>;
-declare const onError: onErrorFunction;
-declare const setOnError: (onErrorFunc: onErrorFunction) => void;
-
-interface RouteResponseObject<TReturnsSchema extends SchemaFieldType | undefined = undefined> {
-    statusCode?: number;
-    headers?: {
-        [key: string]: string;
-    };
-    body: TReturnsSchema extends undefined ? string | object : InferSchemaType<TReturnsSchema>;
-}
-type RouteResponse<TReturnsSchema extends SchemaFieldType = any> = Promise<RouteResponseObject<TReturnsSchema> | void>;
-type OrionRequest<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any> = express.Request<InferPathParams<TPath>, any, InferSchemaType<TBodyParamsSchema>, InferSchemaType<TQueryParamsSchema>>;
-type RouteResolve<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> = (req?: OrionRequest<TPath, TQueryParamsSchema, TBodyParamsSchema>, res?: express.Response, viewer?: any) => RouteResponse<TReturnsSchema>;
-type InferPathParam<Path, NextPart> = Path extends `:${infer OptionalParam}?` ? {
-    [K in OptionalParam]?: string;
-} & NextPart : Path extends `:${infer Param}` ? {
-    [K in Param]: string;
-} & NextPart : NextPart;
-type InternalPathParams<Path> = Path extends `${infer Segment}/${infer Rest}` ? InferPathParam<Segment, InferPathParams<Rest>> : InferPathParam<Path, {}>;
-type InferPathParams<Path> = InternalPathParams<Path>;
-interface OrionRouteOptions<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> {
-    /**
-     * The path of the requests to match.
-     */
-    path: TPath;
-    /**
-     * The schema of the path params. If not provided, the path params will be undefined.
-     * Path params will be cleaned and validated using the schema.
-     */
-    /**
-     * The schema of the body params. If not provided, the body params will be undefined.
-     * Body params will be cleaned and validated using the schema.
-     */
-    bodyParams?: TBodyParamsSchema;
-    /**
-     * The schema of the query params. If not provided, the query params will be undefined.
-     * Query params will be cleaned and validated using the schema.
-     */
-    queryParams?: TQueryParamsSchema;
-    /**
-     * The schema of the return body. If provided, the body will be only cleaned agains this schema, not validated.
-     */
-    returns?: TReturnsSchema;
-    /**
-     * The http method of the requests to match.
-     */
-    method: 'get' | 'post' | 'put' | 'delete' | 'all';
-    /**
-     * Select the body parser to use for this route.
-     */
-    bodyParser?: 'json' | 'text' | 'urlencoded';
-    /**
-     * Selected body parser options.
-     */
-    bodyParserOptions?: OptionsJson | OptionsText | OptionsUrlencoded;
-    /**
-     * Add a middleware to the route.
-     * See https://expressjs.com/en/4x/api.html#middleware
-     * for more information.
-     */
-    middlewares?: Array<express.RequestHandler>;
-    resolve: RouteResolve<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-    /**
-     * Pass another express app
-     */
-    app?: express.Application;
-}
-type RouteType<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any, TReturnsSchema extends SchemaFieldType | undefined = any> = OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-interface RoutesMap {
-    [key: string]: RouteType<any, any, any, any>;
-}
-type Request = express.Request;
-type Response = express.Response;
-
-declare function registerRoute(route: RouteType): void;
-
-declare function registerRoutes(routesMap: RoutesMap): void;
-
-interface StartOrionOptions {
-    keepAliveTimeout?: number;
-}
-declare const startServer: (port?: number, otherOptions?: StartOrionOptions) => express.Express;
-declare const getApp: () => express.Express;
-declare const getServer: () => any;
-
-declare const getViewer: (req: express.Request) => Promise<any>;
-declare const setGetViewer: (getViewerFunc: (req: express.Request) => any) => void;
-
-declare function createRoute<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined>(options: OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>): RouteType<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-/**
- * @deprecated Use createRoute instead
- */
-declare const route: typeof createRoute;
-
-declare function registerReplEndpoint(): void;
-
-declare function Routes(): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function Route(): (method: any, context: ClassFieldDecoratorContext) => any;
-declare function Route(options?: Omit<OrionRouteOptions<any, any, any, any>, 'resolve'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function getServiceRoutes(target: any): RoutesMap;
-
+import { onError, setOnError } from './errors';
+import registerRoute from './routes/registerRoute';
+import registerRoutes from './routes/registerRoutes';
+import { getApp, getServer, startServer } from './start';
+import { getViewer, setGetViewer } from './viewer';
+export * from './routes/route';
 declare const bodyParser: {
     json: () => RequestHandler;
     raw: () => RequestHandler;
@@ -113,5 +13,7 @@ declare const bodyParser: {
         extended: boolean;
     }) => RequestHandler;
 };
-
-export { type InferPathParams, type OrionRequest, type OrionRouteOptions, type Request, type Response, Route, type RouteResolve, type RouteResponse, type RouteResponseObject, type RouteType, Routes, type RoutesMap, bodyParser, createRoute, getApp, getServer, getServiceRoutes, getViewer, onError, registerReplEndpoint, registerRoute, registerRoutes, route, setGetViewer, setOnError, startServer };
+export { express, startServer, getApp, getServer, getViewer, setGetViewer, setOnError, onError, registerRoute, registerRoutes, bodyParser, };
+export { registerReplEndpoint } from './repl';
+export * from './service';
+export * from './types';

package/dist/repl.d.ts

@@ -0,0 +1 @@
+export declare function registerReplEndpoint(): void;

package/dist/routes/executeRequest.d.ts

@@ -0,0 +1,3 @@
+import express from 'express';
+import { OrionRequest, RouteType } from './../types';
+export declare function executeRequest(route: RouteType<any>, req: OrionRequest, res: express.Response): Promise<void>;

package/dist/routes/registerRoute.d.ts

@@ -0,0 +1,2 @@
+import { RouteType } from '../types';
+export default function registerRoute(route: RouteType): void;

package/dist/routes/registerRoutes.d.ts

@@ -0,0 +1,2 @@
+import { RoutesMap } from '../types';
+export default function registerRoutes(routesMap: RoutesMap): void;

package/dist/routes/route.d.ts

@@ -0,0 +1,7 @@
+import { Schema, SchemaFieldType } from '@orion-js/schema';
+import { RouteType, OrionRouteOptions } from '../types';
+export declare function createRoute<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined>(options: OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>): RouteType<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
+/**
+ * @deprecated Use createRoute instead
+ */
+export declare const route: typeof createRoute;

package/dist/service/index.d.ts

@@ -0,0 +1,5 @@
+import { OrionRouteOptions, RoutesMap } from '../types';
+export declare function Routes(): (target: any, context: ClassDecoratorContext<any>) => void;
+export declare function Route(): (method: any, context: ClassFieldDecoratorContext) => any;
+export declare function Route(options?: Omit<OrionRouteOptions<any, any, any, any>, 'resolve'>): (method: any, context: ClassMethodDecoratorContext) => any;
+export declare function getServiceRoutes(target: any): RoutesMap;

package/dist/start.d.ts

@@ -0,0 +1,7 @@
+import express from 'express';
+export interface StartOrionOptions {
+    keepAliveTimeout?: number;
+}
+export declare const startServer: (port?: number, otherOptions?: StartOrionOptions) => express.Express;
+export declare const getApp: () => express.Express;
+export declare const getServer: () => any;

package/dist/types.d.ts

@@ -0,0 +1,74 @@
+import express from 'express';
+import { OptionsJson, OptionsText, OptionsUrlencoded } from 'body-parser';
+import { InferSchemaType, Schema, SchemaFieldType } from '@orion-js/schema';
+export interface RouteResponseObject<TReturnsSchema extends SchemaFieldType | undefined = undefined> {
+    statusCode?: number;
+    headers?: {
+        [key: string]: string;
+    };
+    body: TReturnsSchema extends undefined ? string | object : InferSchemaType<TReturnsSchema>;
+}
+export type RouteResponse<TReturnsSchema extends SchemaFieldType = any> = Promise<RouteResponseObject<TReturnsSchema> | void>;
+export type OrionRequest<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any> = express.Request<InferPathParams<TPath>, any, InferSchemaType<TBodyParamsSchema>, InferSchemaType<TQueryParamsSchema>>;
+export type RouteResolve<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> = (req?: OrionRequest<TPath, TQueryParamsSchema, TBodyParamsSchema>, res?: express.Response, viewer?: any) => RouteResponse<TReturnsSchema>;
+type InferPathParam<Path, NextPart> = Path extends `:${infer OptionalParam}?` ? {
+    [K in OptionalParam]?: string;
+} & NextPart : Path extends `:${infer Param}` ? {
+    [K in Param]: string;
+} & NextPart : NextPart;
+type InternalPathParams<Path> = Path extends `${infer Segment}/${infer Rest}` ? InferPathParam<Segment, InferPathParams<Rest>> : InferPathParam<Path, {}>;
+export type InferPathParams<Path> = InternalPathParams<Path>;
+export interface OrionRouteOptions<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> {
+    /**
+     * The path of the requests to match.
+     */
+    path: TPath;
+    /**
+     * The schema of the path params. If not provided, the path params will be undefined.
+     * Path params will be cleaned and validated using the schema.
+     */
+    /**
+     * The schema of the body params. If not provided, the body params will be undefined.
+     * Body params will be cleaned and validated using the schema.
+     */
+    bodyParams?: TBodyParamsSchema;
+    /**
+     * The schema of the query params. If not provided, the query params will be undefined.
+     * Query params will be cleaned and validated using the schema.
+     */
+    queryParams?: TQueryParamsSchema;
+    /**
+     * The schema of the return body. If provided, the body will be only cleaned agains this schema, not validated.
+     */
+    returns?: TReturnsSchema;
+    /**
+     * The http method of the requests to match.
+     */
+    method: 'get' | 'post' | 'put' | 'delete' | 'all';
+    /**
+     * Select the body parser to use for this route.
+     */
+    bodyParser?: 'json' | 'text' | 'urlencoded';
+    /**
+     * Selected body parser options.
+     */
+    bodyParserOptions?: OptionsJson | OptionsText | OptionsUrlencoded;
+    /**
+     * Add a middleware to the route.
+     * See https://expressjs.com/en/4x/api.html#middleware
+     * for more information.
+     */
+    middlewares?: Array<express.RequestHandler>;
+    resolve: RouteResolve<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
+    /**
+     * Pass another express app
+     */
+    app?: express.Application;
+}
+export type RouteType<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any, TReturnsSchema extends SchemaFieldType | undefined = any> = OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
+export interface RoutesMap {
+    [key: string]: RouteType<any, any, any, any>;
+}
+export type Request = express.Request;
+export type Response = express.Response;
+export {};

package/dist/viewer.d.ts

@@ -0,0 +1,3 @@
+import express from 'express';
+export declare const getViewer: (req: express.Request) => Promise<any>;
+export declare const setGetViewer: (getViewerFunc: (req: express.Request) => any) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/http",
-  "version": "4.3.2",
+  "version": "4.4.0",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "files": [
@@ -8,24 +8,17 @@
   ],
   "author": "nicolaslopezj",
   "license": "MIT",
-  "scripts": {
-    "test": "bun test",
-    "prepare": "bun run build",
-    "clean": "rm -rf ./dist",
-    "build": "tsup",
-    "dev": "tsup --watch"
-  },
   "dependencies": {
-    "@orion-js/env": "4.3.1",
-    "@orion-js/helpers": "4.3.1",
-    "@orion-js/resolvers": "4.3.1",
-    "@orion-js/schema": "4.3.1",
-    "@orion-js/services": "4.3.1",
+    "@orion-js/env": "4.4.0",
+    "@orion-js/helpers": "4.4.0",
+    "@orion-js/resolvers": "4.4.0",
+    "@orion-js/schema": "4.4.0",
+    "@orion-js/services": "4.4.0",
     "body-parser": "1.20.3",
     "express": "4.21.2"
   },
   "peerDependencies": {
-    "@orion-js/logger": "4.3.1"
+    "@orion-js/logger": "4.4.0"
   },
   "devDependencies": {
     "@types/body-parser": "^1.19.1",
@@ -35,7 +28,7 @@
     "superagent": "^10.2.0",
     "supertest": "^7.0.0",
     "tsup": "^8.0.1",
-    "typescript": "^5.4.5"
+    "typescript": "^7.0.2"
   },
   "publishConfig": {
     "access": "public"
@@ -47,5 +40,11 @@
     "types": "./dist/index.d.ts",
     "import": "./dist/index.js",
     "require": "./dist/index.cjs"
+  },
+  "scripts": {
+    "test": "bun test",
+    "clean": "rm -rf ./dist",
+    "build": "tsup && bun run ../../scripts/emit-declarations.ts",
+    "dev": "tsup --watch"
   }
-}
+}

package/dist/index.d.cts

@@ -1,117 +0,0 @@
-import express, { RequestHandler } from 'express';
-export { default as express } from 'express';
-import { OptionsJson, OptionsText, OptionsUrlencoded } from 'body-parser';
-import { Schema, InferSchemaType, SchemaFieldType } from '@orion-js/schema';
-
-type onErrorFunction = (req: express.Request, res: express.Response, error: any) => Promise<void>;
-declare const onError: onErrorFunction;
-declare const setOnError: (onErrorFunc: onErrorFunction) => void;
-
-interface RouteResponseObject<TReturnsSchema extends SchemaFieldType | undefined = undefined> {
-    statusCode?: number;
-    headers?: {
-        [key: string]: string;
-    };
-    body: TReturnsSchema extends undefined ? string | object : InferSchemaType<TReturnsSchema>;
-}
-type RouteResponse<TReturnsSchema extends SchemaFieldType = any> = Promise<RouteResponseObject<TReturnsSchema> | void>;
-type OrionRequest<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any> = express.Request<InferPathParams<TPath>, any, InferSchemaType<TBodyParamsSchema>, InferSchemaType<TQueryParamsSchema>>;
-type RouteResolve<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> = (req?: OrionRequest<TPath, TQueryParamsSchema, TBodyParamsSchema>, res?: express.Response, viewer?: any) => RouteResponse<TReturnsSchema>;
-type InferPathParam<Path, NextPart> = Path extends `:${infer OptionalParam}?` ? {
-    [K in OptionalParam]?: string;
-} & NextPart : Path extends `:${infer Param}` ? {
-    [K in Param]: string;
-} & NextPart : NextPart;
-type InternalPathParams<Path> = Path extends `${infer Segment}/${infer Rest}` ? InferPathParam<Segment, InferPathParams<Rest>> : InferPathParam<Path, {}>;
-type InferPathParams<Path> = InternalPathParams<Path>;
-interface OrionRouteOptions<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined> {
-    /**
-     * The path of the requests to match.
-     */
-    path: TPath;
-    /**
-     * The schema of the path params. If not provided, the path params will be undefined.
-     * Path params will be cleaned and validated using the schema.
-     */
-    /**
-     * The schema of the body params. If not provided, the body params will be undefined.
-     * Body params will be cleaned and validated using the schema.
-     */
-    bodyParams?: TBodyParamsSchema;
-    /**
-     * The schema of the query params. If not provided, the query params will be undefined.
-     * Query params will be cleaned and validated using the schema.
-     */
-    queryParams?: TQueryParamsSchema;
-    /**
-     * The schema of the return body. If provided, the body will be only cleaned agains this schema, not validated.
-     */
-    returns?: TReturnsSchema;
-    /**
-     * The http method of the requests to match.
-     */
-    method: 'get' | 'post' | 'put' | 'delete' | 'all';
-    /**
-     * Select the body parser to use for this route.
-     */
-    bodyParser?: 'json' | 'text' | 'urlencoded';
-    /**
-     * Selected body parser options.
-     */
-    bodyParserOptions?: OptionsJson | OptionsText | OptionsUrlencoded;
-    /**
-     * Add a middleware to the route.
-     * See https://expressjs.com/en/4x/api.html#middleware
-     * for more information.
-     */
-    middlewares?: Array<express.RequestHandler>;
-    resolve: RouteResolve<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-    /**
-     * Pass another express app
-     */
-    app?: express.Application;
-}
-type RouteType<TPath extends string = string, TQueryParamsSchema extends Schema | undefined = any, TBodyParamsSchema extends Schema | undefined = any, TReturnsSchema extends SchemaFieldType | undefined = any> = OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-interface RoutesMap {
-    [key: string]: RouteType<any, any, any, any>;
-}
-type Request = express.Request;
-type Response = express.Response;
-
-declare function registerRoute(route: RouteType): void;
-
-declare function registerRoutes(routesMap: RoutesMap): void;
-
-interface StartOrionOptions {
-    keepAliveTimeout?: number;
-}
-declare const startServer: (port?: number, otherOptions?: StartOrionOptions) => express.Express;
-declare const getApp: () => express.Express;
-declare const getServer: () => any;
-
-declare const getViewer: (req: express.Request) => Promise<any>;
-declare const setGetViewer: (getViewerFunc: (req: express.Request) => any) => void;
-
-declare function createRoute<TPath extends string, TQueryParamsSchema extends Schema | undefined, TBodyParamsSchema extends Schema | undefined, TReturnsSchema extends SchemaFieldType | undefined>(options: OrionRouteOptions<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>): RouteType<TPath, TQueryParamsSchema, TBodyParamsSchema, TReturnsSchema>;
-/**
- * @deprecated Use createRoute instead
- */
-declare const route: typeof createRoute;
-
-declare function registerReplEndpoint(): void;
-
-declare function Routes(): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function Route(): (method: any, context: ClassFieldDecoratorContext) => any;
-declare function Route(options?: Omit<OrionRouteOptions<any, any, any, any>, 'resolve'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function getServiceRoutes(target: any): RoutesMap;
-
-declare const bodyParser: {
-    json: () => RequestHandler;
-    raw: () => RequestHandler;
-    text: () => RequestHandler;
-    urlencoded: (options?: {
-        extended: boolean;
-    }) => RequestHandler;
-};
-
-export { type InferPathParams, type OrionRequest, type OrionRouteOptions, type Request, type Response, Route, type RouteResolve, type RouteResponse, type RouteResponseObject, type RouteType, Routes, type RoutesMap, bodyParser, createRoute, getApp, getServer, getServiceRoutes, getViewer, onError, registerReplEndpoint, registerRoute, registerRoutes, route, setGetViewer, setOnError, startServer };