Packages

Encapsule Project JavaScript libraries and tools are published by @ChrisRus via npmjs.org following semantic versioning conventions.

Published packages are distributed in CommonJS format for immediate use in new or existing Node.js projects. Additionally, several of these packages are designed to also be used in client-side JavaScript applications when bundled with the webpack module bundler.

Encapsule/arccore Package

The ARCcore package is a collection of six separately exported libraries that are typically used together to model and process in-memory data. The package is distributed in pre-built, tested, minimized, and bundled form for convenience, and to reduce its size (~90K minimized). (See "Application Bundle Size" section of the ARCcore.filter Architecture page for additional discussion).

ARCcore is self-contained: its two external dependencies uuid and murmurhash-js are included in the package bundle and exported via the package's __bundle export namespace. This ensures that each ARCcore package release functions in the wild just as it does when tested for release. And, reduces the risk of interoperability problems between separate applications that may leverage the ARCcore run-time.

ARCcore is pure JavaScript and can be used directly in Node.js applications. And, in client-side JavaScript applications when bundled with the webpack module bundler.

ARCcore package .::. ARCcore documentation

~/yourproject$ npm install arccore --save

Encapsule/jsgraph Package

To-date, the most popular package published by Encapsule Project is a library called Encapsule/jsgraph that provides a generic container class for in-memory mathematical directed graph datasets plus a collection of developer-extensible algorithms based on the visitor pattern (Wikipedia).

Encapsule/jsgraph has been around for several years and gets several thousand downloads/month on npm. In 2015, I migrated the code into ARCcore given that I typically never use this functionality without also using the other ARCcore libraries. But, ARCcore is just now getting documented in spring 2017 and nobody really knows about it yet.

So, Encapsule/jsgraph will continue to be maintained and published as a standalone package for the foreseeable future as it's useful by itself. And, serves as a gateway drug for the rest of the libraries in ARCcore.

NOTE: Regardless of if you use jsgraph or ARCcore.graph, the latest documentation for this library is posted on this site. Please ignore the bundled markdown documentation and refer instead to the ARCcore.graph docs instead.

jsgraph is pure JavaScript and can be used directly in Node.js applications. And, in client-side JavaScript applications when bundled with the webpack module bundler.

jsgraph package .::. ARCcore.graph documentation

~/yourproject$ npm install jsgraph --save

Encapsule/holism & Encapsule/holistic

Encapsule/holism is a new application server package for Node.js that will be released later this spring.

Encapsule/holistic is a collection of plug-in extensions for Holism that implement user/session management using a back-end Redis noSQL store, server & client HTML rendering via React, and content management system built with ARCcore.graph.

This website is a pre-release test that seems to be working pretty well. But, the documentation isn't complete yet. Stay tuned...

Sources

All Encapsule Project sub-projects are available on GitHub @Encapsule.

Generally, you'll want to leverage the pre-built and tested packages distributed via npmjs. If you're missing something you need to make progress please get in touch.

License

Encapsule Project libraries and tools are published under the MIT License.