LogoLogo
ChangelogGitHubTwitterGitter
v2.x
v2.x
  • Introduction
  • Overview
    • Getting started
    • Effects
    • Routing
    • Middlewares
    • Error handling
    • How does it glue​ together?
  • Advanced
    • Context
    • Server events
    • Validation
    • Streaming
    • Output interceptor
  • WebSockets
    • Getting started
    • Effects
    • Middlewares
    • Error handling
    • Connections handling
  • API Reference
    • core
      • bindTo
      • createServer
      • combineRoutes
      • createContextToken
      • EffectFactory
      • r.pipe
      • httpListener
      • operator: matchEvent
      • operator: use
    • websockets
      • webSocketListener
      • operator: broadcast
      • operator: mapToServer
    • middleware-body
    • middleware-logger
    • middleware-io
    • middleware-jwt
      • Token signing
    • middleware-joi
    • middleware-cors
    • middleware-multipart
  • Other
    • Migration from version 1.x
    • Changelog
    • FAQ
Powered by GitBook
On this page
  • 2.3.1 - 2019-06-25
  • 2.3.0 - 2019-06-25
  • 2.2.3 - 2019-06-20
  • 2.2.2 - 2019-05-27
  • 2.2.0 - 2019-05-26
  • 2.1.1 - 2019-04-10
  • 2.1.0 - 2019-04-02
  • 2.0.1 - 2019-03-14
  • 2.0.0 - 2019-02-02
  • 2.0.0-rc.3 - 2019-02-24
  • 2.0.0-rc.2 - 2019-02-17
  • 2.0.0-rc.1 - 2019-02-08
  • 2.0.0-rc.0 - 2019-02-03
  • 1.2.1 - 2018-11-05
  • 1.2.0 - 2018-11-05
  • 1.1.1 - 2018-10-21
  • 1.1.0 - 2018-09-29
  • 1.0.0 - 2018-09-18
  • 1.0.0-rc.3 - 2018-09-17
  • 1.0.0-rc.2 - 2018-09-10
  • 1.0.0-rc.1 - 2018-08-14
  • 1.0.0-rc.0 - 2018-07-07
  • 0.5.0 - 2018-06-13
  • 0.4.2 - 2018-06-10
  • 0.4.1 - 2018-06-03
  • 0.4.0 - 2018-05-31
  • 0.3.2 - 2018-05-29
  • 0.3.1 - 2018-05-27
  • 0.3.0 - 2018-05-27
  • 0.2.x - 2018-05-14
  1. Other

Changelog

PreviousMigration from version 1.xNextFAQ

Last updated 5 years ago

2.3.1 - 2019-06-25

Fixes

  • @marblejs/middleware-multipart: fixed an issue when the middleware stream is resolved too early when the stream handler is attached ()

2.3.0 - 2019-06-25

What's new?

  • @marblejs/middleware-multipart: multipart/form-data middleware based on library.

2.2.3 - 2019-06-20

What's new?

  • @marblejs/core: Added ability to apply req/res metadata in testing mode ()

Fixes

  • @marblejs/core: Body is not stringified when it's a stream, regardless of Content-Type header ()

  • @marblejs/core: Query parameter ending with ".com" or similar doesn’t return 500 error () (closes: )

  • @marblejs/core/+internal: Simplified createHttpRequest function and it's usages ()

2.2.2 - 2019-05-27

Fixes

  • @marblejs/middleware-logger: changed LoggerOptions.stream type from fs.WritableStream into WritableLike

2.2.0 - 2019-05-26

Whats new?

  • @marblejs/core: access server event stream via Context serverEvent$ token #128

Fixes

  • @marblejs/core: lazy reader dependencies are bootstrapped only once (during initial context ask) #129

  • @marblejs/websockets: incoming WebSocket connection is validated via verifyClient hook, just before the initial handshake #133

  • @marblejs/middleware-io: requestValidator$ can update decoded values #132 (closes: #131)

  • all - set RxJS peer dependencies to minor version

2.1.1 - 2019-04-10

Whats new?

  • @marblejs/core: added more HTTP statuses #123 (closes: #121)

  • @marblejs/core: ability to grab the initial request from HTTP output$ via EffectMetadata.initiator #124 (closes: #122)

const output$: HttpOutputEffect = (res$, _, { initiator }) =>
  res$.pipe(
    // do something with response
  );

Fixes

  • @marblejs/core: response.handler improved the way of how Node.js streams are detected #125

2.1.0 - 2019-04-02

Whats new?

  • @marblejs/core: added support for passing Node.js streams into HttpEffectResponse body #116 (closes: #114)

  • @marblejs/middleware-cors: introducing the new middleware that can be used to enable CORS with various options #100 (author: @Edouardbozon) 👏🎉

  • @marblejs/middleware-logger: filter can handle incoming requests and outgoing responses #117 (closes: #115)

2.0.1 - 2019-03-14

Whats new?

  • @marblejs/core - added missing server events parameters

2.0.0 - 2019-02-02

Over the past few months, we've been working hard on the next generation of Marble.js. Today we're thrilled to announce the second major release and all the exciting features that come with it. 🔥🎉🚀

2.0.0-rc.3 - 2019-02-24

pre-release

Whats new?

Breaking changes

In order to use httpListener directly connected to http.createServer you have to run Reader context first:

import { createContext } from '@marblejs/core';
import * as http from 'http';
import httpListener from './http.listener';

const httpListenerWithContext = httpListener
  .run(createContext());

export const server = http
  .createServer(httpListenerWithContext)
  .listen(1337, '127.0.0.1');

2.0.0-rc.2 - 2019-02-17

pre-release

Whats new?

2.0.0-rc.1 - 2019-02-08

pre-release

Whats new?

2.0.0-rc.0 - 2019-02-03

pre-release

Whats new?

  • @marblejs/core - improved type declaration of combineRoutes function

  • @marblejs/middlware-io - introducing new effect validation middleware based on io-ts library

  • @marblejs/middlware-body - entrypoint allows to pass configuration object

  • TypeScript v3.3.x support

Breaking changes

    • Effect -> HttpEffect

    • Middleware -> HttpMiddlewareEffect

    • ErrorEffect -> HttpErrorEffect

Deprecation warnings

1.2.1 - 2018-11-05

Whats new?

1.2.0 - 2018-11-05

Whats new?

  • @marblejs/core - Corrected nullable values detection inside Maybe monad

From version v1.2 the logger$ entry point is marked as deprecated. Use loggerWithOpts$ instead. From the version v2.x the old entry point will be swapped with newer implementation

1.1.1 - 2018-10-21

Whats new?

1.1.0 - 2018-09-29

10 days ago we've got an official v1.0.0 release - this time we have another cool news to share with you!

Whats new?

  • Resolved an issue in the scenario when the grouped middleware throws an error (eg. when request is not authorized) and connected Effect endpoint unexpectedly catches the thrown error. See more details please visit #73

  • Support for TypeScript v3.1.x

  • [internal] - Moved back from webpack to well-tested tsc compiler which makes our build artifacts more predictable and less error prone

1.0.0 - 2018-09-18

1.0.0-rc.3 - 2018-09-17

Whats new?

const getFile$ = EffectFactory
  .matchPath('/:dir*')
  .matchType('GET')
  .use(req$ => req$
    .pipe(
      map(req => req.params.dir as string),
      switchMap(readFile(STATIC_PATH)),
      map(body => ({ body }))
    ));
  • Fixed a problem with incorrectly generated declaration files for @marblejs/middleware-joi package.

1.0.0-rc.2 - 2018-09-10

pre-release

Whats new?

  • Fixed problem with incorrectly concatenated wildcard endpoint when combined with parametrized route.

const notFound$ = EffectFactory
  .matchPath('*')
  .matchType('*')
  .use(req$ => req$.pipe(
    switchMap(() =>
      throwError(new HttpError('Route not found', HttpStatus.NOT_FOUND))
    )
  ));

export const api$ = combineRoutes(
  '/api/:version',
  [ notFound$ ],
);
  • For non-TypeScript developers there was no validation made during app startup, eg. EffectFactory methods were not validated if developer provided wrong HTTP method to the matchType. Going to the expectations we introduced dedicated CoreError type used for throwing an package related error messages, eg. for notifying non-TypeScript developers if they made a mistake in the method arguments.

  • TypeScript v.3.0.x support

  • RxJS v6.2.2 support

  • Lerna v3.3.0 support

  • Introduced Webpack based build process - from now builds are optimized and properly compressed

1.0.0-rc.1 - 2018-08-14

pre-release

Breaking changes:

  • Changed httpListener error handler attribute from errorMiddleware 👉 errorEffect. There was an inconsistency with previous error handler definition and naming. We had to correct this because error handler acts as an Effect instead of Middleware.

Old bootstrapping API:

const app = httpListener({
  middlewares,
  effects,
  errorMiddleware,  👈
});

New bootstrapping API:

const app = httpListener({
  middlewares,
  effects,
  errorEffect,  👈
});

Whats new?

  • Exposed res.send method - from now you don't have to send response manually via dedicated Node.js http.OutgoingMessage API. The res.send method returns an empty stream, thus it can be easily composed inside middleware pipeline.

const middleware$: Middleware = (req$, res) =>
  req$.pipe(
    switchMap(() => res.send({ body: 💩, status: 304, headers: /* ... */ }),
  );
  • Exposed type aliases for common Marble.js architectural blocks:

const effect$: Effect = req$ =>
  req$.pipe(
    // ...
  );

const middleware$: Middleware = (req$, res) =>
  req$.pipe(
    // ...
  );

const error$: ErrorEffect = (req$, res, err) =>
  req$.pipe(
    // ...
  );

1.0.0-rc.0 - 2018-07-07

pre-release

Breaking changes

  • In order to factorize the routing table statically, we need to introduce the breaking change in Effect API definition.

Old Effect API:

const getUsers$: Effect = request$ =>
  request$.pipe(
    matchPath('/'),
    matchType('GET'),
    // ...
  );

New Effect API:

const getUsers$ = EffectFactory
  .matchPath('/')
  .matchType('GET')
  .use(req$ => req$.pipe(
    // ...
  ));
  • separately imported matchPath and matchType stream operators are removed and are part of EffectFactory instead.

Whats new?

  • @marblejs/core - internals - refactored + rebuilt routing resolving mechanism. Thanks to the latest changes we gained hudge performance boost.

  • @marblejs/core - internals - improved performance for middleware resolving flow

  • @marblejs/core - internals - rewritten URL params intercepting mechanism

  • @marblejs/middleware-body - added support for x-www-form-urlencoded Content-Type

0.5.0 - 2018-06-13

pre-release

Fixes

Whats new?

0.4.2 - 2018-06-10

pre-release

Fixes

0.4.1 - 2018-06-03

pre-release

Fixes

  • added support for TypeScript v2.9.1

0.4.0 - 2018-05-31

pre-release

Fixes

Whats new?

  • HttpError constructor now can take data: object as optional third argument

0.3.2 - 2018-05-29

pre-release

Fixes

Whats new?

  • mime-type / content-type auto detection

0.3.1 - 2018-05-27

pre-release

Fixes

  • corrected peerDependency versions for @marblejs/* packages

0.3.0 - 2018-05-27

pre-release

Breaking changes

  • moved bodyParser$ and logger$ middleware outside @marblejs/core to separete@marblejs/middleware-body and @marblejs/middleware-logger packages

Whats new?

  • minor bugfixes and code improvements

0.2.x - 2018-05-14

pre-release

Initial pre-release version

@marblejs/core - replaced StaticInjectorContainer with Context API

@marblejs/core - running HTTP server is not registered anymore in context API

@marblejs/core - createServer doesn't start listening automatically. You have to run it manually via createServer().run();

@marblejs/core - replaced bind.to function with curried bindTo

@marblejs/websockets - module doesn't depend anymore on running HTTP server dependency

@marblejs/core - added new API for defining HTTP route via monadic pipe builder

@marblejs/core - added support for HTTPS servers

@marblejs/core - fixed incorrectly parsed query parameters

@marblejs/middleware-body - fixed incorrectly parsed URL-encoded parameters

@marblejs/middleware-body - Extended middleware API by customizable parsers

@marblejs/middleware-body - The middleware can pass the request through without any work if the content type is not matched. It creates the possibility of chaining multiple body parsers.

@marblejs/middleware-body - Fixed wrongly parsed application/x-www-form-urlencoded body types

@marblejs/core - improved type-inference of combined middlewares

@marblejs/core - Effect response output stream

@marblejs/core - createServer bootstrapping function

@marblejs/websockets - WebSockets module

@marblejs/middlware-joi - improved middleware type inference

@marblejs/core - Improved request type inference. req.params, req.body, req.query are by default of unknown type instead of any

@marblejs/core - httpListener config properties renaming

@marblejs/core - The third argument is a common EffectMetadata object which can contain eventual error object or contextual injector.

@marblejs/core

Deprecated @marblejs/middleware-joi package. Use @marblejs/middleware-io instead.

Deprecated @marblejs/middleware-logger loggerWithOpts$ entrypoint.

@marblejs/core - fixed an issue with missing chalk dependency (issue: )

@marblejs/middleware-logger - extended available API (see: chapter)

@marblejs/core resolves (path matching for trailing slash combined with wildcard parameter)

Introducing new package @marblejs/middleware-jwt - a HTTP requests authentication middleware based on mechanism. 🚀 🎉 For more API reference please visit our official .

Integration with library

Support for wildcard parameter, eg. /foo/:param*. For more details see:

corrected @marblejs/middleware-logger response time logging (issue: )

combineRoutes() API allows to compose middlewares for grouped routes (feature request: ) (see )

fixed an issue with not matched routes in case of reordered matchType and matchPathoperators for the same routes but with different methods (PR )

resolved an issue with TypeScript compiler flag responsible for strict function types (issue: )

fixed an issue with Effects matching hazard (issue: )

ability to create 404 handlers using matchType('*') and matchPath('*') (issue: )

support for non-JSON Effect return types (issue:) Thanks !

added support for intercepting path parameters req.params (see: chapter)

added support for intercepting query parameters req.query (see: chapter)

ability to compose middlewares inside Effect request pipeline via use operator (see: chapter)

new middleware @marblejs/middleware-joi - a Joi

#151
busboy
#141
#137
#147
#145
#140
#106
#106
#106
#106
#106
#103
#105
#104
#104
#102
#102
#101
#88
#96
#89
#91
#89
#88
#88
#92
#94
#95
#97
#99
#98
#77
middleware-logger
#67
JWT
documentation
path-to-regexp
example implementation
#48
#46
#43
#35
#27
#33
@couzic
validation middleware
#36
Middlewares
docs
Routing
Routing
We made it! 🚀