@teambit/express 0.0.939 → 0.0.940

package/artifacts/preview/teambit_harmony_express-preview.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/express-preview"]=t():e["teambit.harmony/express-preview"]=t()}(self,(()=>(()=>{"use strict";var e={83874:(e,t,o)=>{var r={id:"teambit.harmony/express@0.0.940",homepage:"https://bit.cloud/teambit/harmony/express",exported:!0};function n(){const e=i(o(87363));return n=function(){return e},e}function i(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,n.__bit_component=r,i.__bit_component=r;const s=()=>n().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},n().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/express.svg"}));s.__bit_component=r,t.Logo=s},87363:e=>{e.exports=React}},t={};function o(r){var n=t[r];if(void 0!==n)return n.exports;var i=t[r]={exports:{}};return e[r](i,i.exports,o),i.exports}o.d=(e,t)=>{for(var r in t)o.o(t,r)&&!o.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var r={};return(()=>{o.r(r),o.d(r,{compositions:()=>u,compositions_metadata:()=>l,overview:()=>f});var e={};o.r(e),o.d(e,{default:()=>d});var t=o(83874);o(87363);const n=MdxJsReact,i=TeambitMdxUiMdxScopeContext;var s=["components"];function p(){return p=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var r in o)Object.prototype.hasOwnProperty.call(o,r)&&(e[r]=o[r])}return e},p.apply(this,arguments)}var a={},c="wrapper";function d(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,r,n=function(e,t){if(null==e)return{};var o,r,n={},i=Object.keys(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||(n[o]=e[o]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(n[o]=e[o])}return n}(e,s);return(0,n.mdx)(c,p({},a,o,{components:t,mdxType:"MDXLayout"}),(0,n.mdx)(i.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"}))}d.isMDXComponent=!0;const u=[t],f=[e],l={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),r})()));

package/dist/{preview-1703647408454.js → preview-1703698405864.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_express@0.0.939/dist/express.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_express@0.0.939/dist/express.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_express@0.0.940/dist/express.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_express@0.0.940/dist/express.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@teambit/express",
-  "version": "0.0.939",
+  "version": "0.0.940",
   "homepage": "https://bit.cloud/teambit/harmony/express",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "express",
-    "version": "0.0.939"
+    "version": "0.0.940"
   },
   "dependencies": {
     "body-parser": "1.19.0",
     "express": "4.17.1",
     "lodash": "4.17.21",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.840",
-    "@teambit/logger": "0.0.933"
+    "@teambit/cli": "0.0.841",
+    "@teambit/logger": "0.0.934"
   },
   "devDependencies": {
     "@types/express": "4.17.13",
@@ -22,7 +22,7 @@
     "@types/mocha": "9.1.0",
     "@types/jest": "^29.2.2",
     "@types/testing-library__jest-dom": "^5.9.5",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.14"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.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,174 +0,0 @@
-import { MainRuntime } from '@teambit/cli';
-import { Server } from 'http';
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
-import express, { Express } from 'express';
-import { concat, flatten, lowerCase, sortBy } 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 an express server.
-   */
-  async listen(port?: number): Promise<Server> {
-    const serverPort = port || this.config.port;
-    const app = this.createApp();
-    return 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',
-        disableNamespace: false,
-        priority: 0,
-        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 sortedRoutes = sortBy(allRoutes, (r) => r.priority).reverse();
-    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);
-
-    const middlewaresSlot = this.middlewareSlot.values().flat();
-    middlewaresSlot.forEach(({ route, middleware }) => {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      if (!route) app.use(middleware);
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      if (route) app.use(route, middleware);
-    });
-
-    sortedRoutes.forEach((routeInfo) => {
-      const { method, path, middlewares, disableNamespace } = routeInfo;
-      // TODO: @guy make sure to support single middleware here.
-      const namespace = disableNamespace ? '' : `/${this.config.namespace}`;
-      app[method](`${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,
-          disableNamespace: route.disableNamespace,
-          middlewares,
-          priority: route.priority || 0,
-        };
-      });
-    });
-
-    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,7 +0,0 @@
-export type { RouteSlot } from './express.main.runtime';
-export type { Route } from './types';
-export { Verb } from './types';
-export type { Request, Response, NextFunction, Middleware } from './types';
-export type { MiddlewareManifest } from './middleware-manifest';
-export type { ExpressMain } from './express.main.runtime';
-export { ExpressAspect } from './express.aspect';

package/middleware-manifest.ts

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