API Reference Vac Engine v1.1.1
Modules
This context defines the backend part of the VacEngine application i.e. it's business logic and data management.
Rsponsible for the management of a role-based permission system.
Utility to parse a string to a given type, returning meaningful errors if parsing is impossible.
Hash utilities
The Processor module is responsible for generating and executing functions to compute API output from API input.
Represent the blueprint "simple" AST
Compile AST
Convert utilities
Produces the description of a processor from it's blueprint description.
The information provided by this module correspond to the
VacEngine.Pub.info_cached/1 function and the GET info API endpoint.
Blueprint functions library queries
Actual blueprint expression functions
Compiler helpers
Processor state
Processor state runtime environment
Processor state input functions
State heplers to manipulate list varibales
Provides a publication manager to allow processors to be accessible through the API.
This module is used in production to provide an interface to the app from the command line.
Provides the model for the blueprint simulation. Simulation is used to assess whether a ruleset meets business requirements.
Simple stacks are stacks with only two layers
The entrypoint for defining your web interface, such as controllers, views, channels and so on.
Translates controller action results into valid Plug.Conn responses.
Receives requests to the corresponding portal.
Editor for a single ApiKey.
Index of all API keys.
Form for API-key creation.
Authentication controller.
Login page.
Form component for the user login.
Button to duplicate current blueprint.
Main blueprint edition page.
Blueprint import page.
Blueprint importation component.
The list of the blueprints in the current workspace.
The new blueprint creation page.
Contains general informations and controls about the current blueprint.
A button with click confirmation capabilities.
The workspaces dashboard (TODO remove and redirect to blueprints)
Conveniences for translating and building error messages.
Export controller. Used for blueprint download.
Translates controller action results into valid Plug.Conn responses.
A module providing Internationalization with a gettext-based API.
The user icon at the left of the screen that open the user menu when clicked.
The user menu that pops when the user icon is clicked. It contains info about the user, the current workspace and controls to change workspace or reach user settings.
The container for the sub-level section buttons.
The title in the middle of the header. It depends on the current context.
The container for the top level sections of the header.
The header of the application page. It is composed of two levels. The top level contains top sections like "blueprint" and "portals". The sub level contains subsections related to the currently selected top secton (e.g. deduction or simulation for the blueprint section).
Icon loaded from a file based on the @name argument.
A simple component to display info.
A card with a loader.
Provides functions necessary to check persissions.
Module with named helpers generated from VacEngineWeb.Router.
Show variable name indented with dashes according its position in the structure.
A card with a text inside.
A toggle component with a confirm click capabilitiy.