Total.js v3.3.0

Big day is here! I'm very happy to announce a new version of Total.js framework. This version brings really great new features, bug fixes and core elements for Total.js v4. Total.js is very complex Node.js framework, maybe without any direct competition (due to features). So enjoy this version with more than a hundred changes!

• Full changelog
• How to update framework? $ npm install total.js
• Total.js Documentation
• Total.js Examples
• Homepage: www.totaljs.com

This version of Total.js framework is sponsored by LabLynx, Inc.

New features

Session module

Finally, this version of Total.js framework supports session module. The module is very sophisticated and designed for the best performance and usage. In dozens of applications, we needed the users to have full control of managing their open sessions. So, with the session module, the users are able to cancel their existing sessions for a specific device or browser.

• May work in Cluster
• Can be optimized for e.g. Redis
• Documentation
• Example

The module is a bit specific because it works only with two identifiers id (e.g. userid) and sessionid. Session data is loaded when needed, so the module stores only the identifiers, with some additional data, to HDD. Read the documentation for more information or learn from examples.

Example of real usage:

Improved routing

We have improved routing with few details.

Simplified Authorize/Unauhorize flags:

// Authorize
ROUTE('+GET  /api/users/    *Users       --> @query');

// Unauthorize
ROUTE('-POST /api/login/    *Users/Login --> @exec');

Improved dynamic schemas:

ROUTE('GET /api/settings/{schema_name}/ *{settings/schema_name} --> @read');

Better handling (404) not existing static files:

FILE404(function(req, res) {
    // Will be executed if some static file won't existing
    res.throw404();
});

Improved schemas

Schemas have been improved a lot. We have added new methods, properties and functionality, which make coding more convenient, than ever before.

• new type Number2 with default value null, not 0
• improved default values, for example: schema.define('parentid', UID)(null)

Patch method

v3.3.0 finally brings PATCH HTTP method support in Total.js schemas. If the request contains PATCH method, the framework enables a special validation for received data only (not for the entire schema).

ROUTE('PATCH  /api/users/{id}/   *Users --> @patch');

NEWSCHEMA('Users', function(schema) {

    schema.define('name', 'Capitalize(50)', true);
    schema.define('email', 'Email', true);

    schema.setPatch(function($) {
        // $.keys  {Array}  contains only received keys
        // $.model {Object} contains only received data according to the schema
    });
});

Schemas support middleware:

NEWSCHEMA('Users', function(schema) {

    schema.middleware(function($, next) {

        // @$ {SchemaOptions} A name of operation
        // @next([stop]) {Function} A follow-up function

        // Good to know:
        // "$.name" contains a schema operation name ("save", "get", "query", "remove", "workflow:NAME", "transform:name")

        if ($.user.sa && $.name !== 'query')
            next();
        else {
            $.invalid('error-permissions');
            next(true); // The next operation will be canceled
        }

    });

});

Preferences

This was a missing feature for most of Total.js products. Preferences are a simple object for storing persistent data. Preferences are persistent and they work in Cluster.

Usage:

// Write:
PREF.set('name', 'Total.js');
PREF.set('url', 'https://www.totaljs.com');

// Read:
console.log(PREF.name);
console.log(PREF.url);

Total.js Components support Parts

This was great idea. Primary we use Total.js components for extending of existing apps. Now a developer can specify parts in the views, where the parts from components will be rendered.

A component declaration:

A component content.

@{part header}
    HEADER
@{end}

@{part footer}
    FOOTER
@{end}

<script total>
    exports.group = 'cms';
</script>

Usage in views:

<header>
    <!-- Here will be rendered all parts of components which contain part "header" -->
    @{part('header')}
</header>

<main>
    BLA BLA
</main>

<footer>
    <!-- Here will be rendered all parts of components which contain part "footer" -->
    @{part('footer')}
</footer>

@{components('cms')}

Audit logs for all operations

Very helpful method for logging operations. More information in documentation. The method stores the data below:

• message
• type if exists
• parsed user id as userid (if exists)
• parsed user name as username (if exists)
• parsed user-agent as ua
• creation date
• IP address

// AUDIT(filename, $, [type], message);
schema.setInsert(function($) {
    AUDIT('schemas', $, '')
});

Auto-localization of all .html static files

Very important change, you don't need to use LOCALIZE() method. This version performs localization and minification for all .html static files automatically. You can disable this behavior in config file:

allow_localize     : false

Proxy server

Finally, we have extended Total.js framework by adding PROXY() method, which can register proxy routing to external source. Example:

PROXY('/users/', 'https://www.totaljs.com/users/', function(uri, req, res) {
    // @uri {Object} Prepared URL address
    // @req {Request} Incoming request
    // @res {Response} A resposne for incoming request
    uri.headers['x-token'] = '123456';
});

New global variables

• ACTION() simulates a request to a route, read documentation
• MAIN for storing of some main data of the application
• REPO for storing of some repository data of the application
• FUNC for storing of global functions
• SESSION() for obtaining of session instance
• MODIFY() as alias for F.modify()
• VIEWCOMPILE() as alias for F.view_compile()
• $ACTION() executes a schema operation directly, read documentation

New utitilies

• String.parseCSV([delimiter]) for parsing CSV files
• String.parseUA([structured]) for parsing user-agent

Updates

Updated UID()

This version brings a new generator for unique identificators with 100% backward compatibilty. Example:

OLD: 17082512500002gkj0
NEW: 345489001xk1a

RESTBuilder supports keep-alive

Works only with http protocol, but can increase performance for repeated requests.

RESTBuilder.GET('http://127.0.0.1:8000').keepalive().exec(console.log);

ImageMagick 7

We have added a support for ImageMagick v7, but you need to enable it:

default_image_converter  : magick

Fixes

We have fixed small bugs (not critical). All fixes are mentioned in changelog.

Future

We will prepare Total.js v4. Currently, we are working on new open-source products. Stay tuned and Follow us on Twitter.

Become our sponsor

We are looking for sponsors who can help us improve Total.js platform. We have created a lot of great open-source products which you can use without any fees. Are you interested? Contact us.