@teambit/express 0.0.471 → 0.0.476

package/dist/express.main.runtime.d.ts

@@ -11,14 +11,45 @@ export declare type ExpressConfig = {
 export declare type MiddlewareSlot = SlotRegistry<MiddlewareManifest[]>;
 export declare type RouteSlot = SlotRegistry<Route[]>;
 export declare class ExpressMain {
+    /**
+     * extension config
+     */
     readonly config: ExpressConfig;
+    /**
+     * slot for registering graphql modules
+     */
     private moduleSlot;
+    /**
+     * logger extension.
+     */
     readonly logger: Logger;
     readonly middlewareSlot: MiddlewareSlot;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
-    constructor(config: ExpressConfig, moduleSlot: RouteSlot, logger: Logger, middlewareSlot: MiddlewareSlot);
+    constructor(
+    /**
+     * extension config
+     */
+    config: ExpressConfig, 
+    /**
+     * slot for registering graphql modules
+     */
+    moduleSlot: RouteSlot, 
+    /**
+     * logger extension.
+     */
+    logger: Logger, middlewareSlot: MiddlewareSlot);
+    /**
+     * start a express server.
+     */
     listen(port?: number): Promise<void>;
+    /**
+     * register a new express routes.
+     * route will be added as `/api/${route}`
+     */
     register(routes: Route[]): this;
+    /**
+     * register a new middleware into express.
+     */
     registerMiddleware(middlewares: MiddlewareManifest[]): this;
     private createRootRoutes;
     createApp(expressApp?: Express, options?: {

package/dist/types/route.d.ts

@@ -2,11 +2,17 @@
 import { NextFunction } from './next';
 import { Request } from './request';
 import { Response } from './response';
+/**
+ * define express Middleware
+ */
 export declare type Middleware = (req: Request, res: Response, next: NextFunction) => Promise<any>;
 export declare enum Verb {
     WRITE = "write",
     READ = "read"
 }
+/**
+ * express new Route
+ */
 export interface Route {
     method: string;
     route: string | RegExp;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/express",
-  "version": "0.0.471",
+  "version": "0.0.476",
   "homepage": "https://bit.dev/teambit/harmony/express",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "express",
-    "version": "0.0.471"
+    "version": "0.0.476"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -15,8 +15,8 @@
     "lodash": "4.17.21",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.382",
-    "@teambit/logger": "0.0.467"
+    "@teambit/cli": "0.0.387",
+    "@teambit/logger": "0.0.472"
   },
   "devDependencies": {
     "@types/express": "4.17.9",
@@ -29,7 +29,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -57,12 +57,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/express.aspect.ts

@@ -1,7 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const ExpressAspect = Aspect.create({
-  id: 'teambit.harmony/express',
-  dependencies: [],
-  defaultConfig: {},
-});

package/express.main.runtime.ts

@@ -1,164 +0,0 @@
-import { MainRuntime } from '@teambit/cli';
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
-import express, { Express } from 'express';
-import { concat, flatten, lowerCase } from 'lodash';
-import bodyParser from 'body-parser';
-import { ExpressAspect } from './express.aspect';
-import { catchErrors } from './middlewares';
-import { Middleware, Request, Response, Route, Verb } from './types';
-import { MiddlewareManifest } from './middleware-manifest';
-
-export type ExpressConfig = {
-  port: number;
-  namespace: string;
-  loggerIgnorePath: string[];
-};
-
-export type MiddlewareSlot = SlotRegistry<MiddlewareManifest[]>;
-
-export type RouteSlot = SlotRegistry<Route[]>;
-
-export class ExpressMain {
-  static runtime = MainRuntime;
-
-  constructor(
-    /**
-     * extension config
-     */
-    readonly config: ExpressConfig,
-
-    /**
-     * slot for registering graphql modules
-     */
-    private moduleSlot: RouteSlot,
-
-    /**
-     * logger extension.
-     */
-    readonly logger: Logger,
-
-    readonly middlewareSlot: MiddlewareSlot
-  ) {}
-
-  /**
-   * start a express server.
-   */
-  async listen(port?: number) {
-    const serverPort = port || this.config.port;
-    const app = this.createApp();
-    app.listen(serverPort);
-  }
-
-  /**
-   * register a new express routes.
-   * route will be added as `/api/${route}`
-   */
-  register(routes: Route[]) {
-    this.moduleSlot.register(routes);
-    return this;
-  }
-
-  /**
-   * register a new middleware into express.
-   */
-  registerMiddleware(middlewares: MiddlewareManifest[]) {
-    this.middlewareSlot.register(middlewares);
-    return this;
-  }
-
-  private createRootRoutes() {
-    // TODO: @guy refactor health to service aspect.
-    return [
-      {
-        namespace: ExpressAspect.id,
-        method: 'get',
-        path: '/_health',
-        middlewares: [async (req: Request, res: Response) => res.send('ok')],
-      },
-    ];
-  }
-
-  createApp(expressApp?: Express, options?: { disableBodyParser: true }): Express {
-    const internalRoutes = this.createRootRoutes();
-    const routes = this.createRoutes();
-    const allRoutes = concat(routes, internalRoutes);
-    const app = expressApp || express();
-    app.use((req, res, next) => {
-      if (this.config.loggerIgnorePath.includes(req.url)) return next();
-      this.logger.debug(`express got a request to a URL: ${req.url}', headers:`, req.headers);
-      return next();
-    });
-    if (!options?.disableBodyParser) this.bodyParser(app);
-
-    this.middlewareSlot
-      .toArray()
-      .flatMap(([, middlewares]) =>
-        middlewares.flatMap((middlewareManifest) => app.use(middlewareManifest.middleware))
-      );
-    allRoutes.forEach((routeInfo) => {
-      const { method, path, middlewares } = routeInfo;
-      // TODO: @guy make sure to support single middleware here.
-      app[method](`/${this.config.namespace}${path}`, this.catchErrorsMiddlewares(middlewares));
-    });
-
-    return app;
-  }
-
-  private createRoutes() {
-    const routesSlots = this.moduleSlot.toArray();
-    const routeEntries = routesSlots.map(([, routes]) => {
-      return routes.map((route) => {
-        const middlewares = flatten([this.verbValidation(route), route.middlewares]);
-        return {
-          method: lowerCase(route.method),
-          path: route.route,
-          middlewares,
-        };
-      });
-    });
-
-    return flatten(routeEntries);
-  }
-
-  private verbValidation(route: Route): Middleware {
-    return async (req: express.Request, res: express.Response, next: express.NextFunction) => {
-      if (!route.verb) return next();
-      const verb = req.headers['x-verb'] || Verb.READ;
-      if (verb !== route.verb) {
-        res.status(403);
-        return res.jsonp({ message: 'You are not authorized', error: 'forbidden' });
-      }
-      return next();
-    };
-  }
-
-  private catchErrorsMiddlewares(middlewares: Middleware[]) {
-    return middlewares.map((middleware) => catchErrors(middleware));
-  }
-
-  private bodyParser(app: Express) {
-    app.use(bodyParser.json({ limit: '5000mb' }));
-    app.use(bodyParser.raw({ type: 'application/octet-stream', limit: '5000mb' }));
-  }
-
-  static slots = [Slot.withType<Route[]>(), Slot.withType<MiddlewareManifest[]>()];
-  static dependencies = [LoggerAspect];
-
-  static defaultConfig = {
-    port: 4001,
-    namespace: 'api',
-    loggerIgnorePath: ['/api/_health'],
-  };
-
-  static async provider(
-    [loggerFactory]: [LoggerMain],
-    config: ExpressConfig,
-    [routeSlot, middlewareSlot]: [RouteSlot, MiddlewareSlot]
-  ) {
-    const logger = loggerFactory.createLogger(ExpressAspect.id);
-    return new ExpressMain(config, routeSlot, logger, middlewareSlot);
-  }
-}
-
-ExpressAspect.addRuntime(ExpressMain);

package/index.ts

@@ -1,5 +0,0 @@
-export { RouteSlot } from './express.main.runtime';
-export { Route, Verb } from './types';
-export { Request, Response, NextFunction } from './types';
-export type { ExpressMain } from './express.main.runtime';
-export { ExpressAspect } from './express.aspect';

package/middleware-manifest.ts

@@ -1,5 +0,0 @@
-import { Middleware } from './types';
-
-export interface MiddlewareManifest {
-  middleware: Middleware;
-}

package/middlewares/error.ts

@@ -1,29 +0,0 @@
-import * as express from 'express';
-import logger from '@teambit/legacy/dist/logger/logger';
-
-interface ResponseError {
-  status?: number;
-  message?: string;
-}
-
-export const catchErrors = (action: any) => (req: express.Request, res: express.Response, next: express.NextFunction) =>
-  // TODO: @guy please take care of it
-  // eslint-disable-next-line promise/no-callback-in-promise
-  action(req, res, next).catch((error: ResponseError) => errorHandle(error, req, res, next));
-
-export function errorHandle(
-  err: ResponseError,
-  req: express.Request,
-  res: express.Response,
-  // TODO: Do not remove unused next, it's needed for express to catch errors!
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  next: express.NextFunction
-) {
-  logger.error(`express.errorHandle, url ${req.url}, error:`, err);
-  err.status = err.status || 500;
-  res.status(err.status);
-  return res.jsonp({
-    message: err.message,
-    error: err,
-  });
-}

package/middlewares/index.ts

@@ -1 +0,0 @@
-export { catchErrors, errorHandle } from './error';

package/tsconfig.json

@@ -1,35 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
-    ],
-    "target": "es2015",
-    "module": "commonjs",
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "rootDir": ".",
-    "removeComments": true,
-    "preserveConstEnums": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/index.ts

@@ -1,4 +0,0 @@
-export { Request } from './request';
-export { Response } from './response';
-export { NextFunction } from './next';
-export { Route, Middleware, Verb } from './route';

package/types/next.ts

@@ -1,3 +0,0 @@
-import express from 'express';
-
-export type NextFunction = express.NextFunction;

package/types/request.ts

@@ -1 +0,0 @@
-export type { Request } from 'express';

package/types/response.ts

@@ -1,3 +0,0 @@
-import express from 'express';
-
-export type Response = {} & express.Response;

package/types/route.ts

@@ -1,24 +0,0 @@
-import { NextFunction } from './next';
-import { Request } from './request';
-import { Response } from './response';
-
-/**
- * define express Middleware
- */
-export type Middleware = (req: Request, res: Response, next: NextFunction) => Promise<any>;
-
-export enum Verb {
-  WRITE = 'write',
-  READ = 'read',
-}
-
-/**
- * express new Route
- */
-
-export interface Route {
-  method: string;
-  route: string | RegExp;
-  verb?: Verb;
-  middlewares: Middleware[];
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}