atlas_gateway v2.0.0

Atlas Framework

This framework serves as a gateway between the ATLAS solution and a front-end application.

What is this repository for?

With this framework, users are able to connect to the Atlas aplication, allowing them to:

• Authenticate
• Perform CRUD operations:
  • Read
  • Create
  • Update
  • Delete
• Use a integrated CLI to create and upload a Migration to ATLAS, suported ATLAS Types: .
  • Repositories
  • Classes
  • Properties

To Start using the Library

You can set it with NPM up using:

npm install atlas_gateway

To Use the CLI

Open the Terminal in your Project Localization

Use the Following Commands in your terminal

npm run atlas_gateway

or

npx atlas_gateway

After opening the CLI, you have 4 different options:

• Create repository script
• Create migration from metamodel file
• Send migration to Atlas application
• Create components

TODO: Explain create components

Repository script

The ModelBuilder allows you to create:

• 1 Repository
• n Classes
• n Properties
• n Templates, which allow you to create a template for a class creation

Example:

let template = new ModelBuilder.Template(
	new ModelBuilder.Property(...),
	new ModelBuilder.Property(...),
	new ModelBuilder.Property(...),
	...
);

new ModelBuilder.Repository(RepositoryName, {
	new ModelBuilder.Class(ClassName, {
		new ModelBuilder.Property(PropertyName),
		new ModelBuilder.Property(PropertyName),
		new ModelBuilder.Property(PropertyName),
		...
	}).addTemplate(template);
	new ModelBuilder.Class(ClassName, {
		...
	});
}) 

The property field can have options with the Property.option(); There are several ones

• hasMetatype(x) -> Defines the metatype of the property
• isHistoryField()
• isRichText()
• minValue()
• maxValue()
• range(min, max)
• possibleValues(...values)

To use the CRUD

Require it in your project's configuration:

const atlas = require('atlas-gateway');
Vue.prototype.$atlas = atlas;

Now you can connect to the Atlas app using this.$atlas

Authentication

In order to authenticate to the Atlas application, you simply need to call it in your login form

this.$atlas.auth({url, username, password});

This adds a user token and the tenantId to the headers 'ATLAS-AUTH-TOKEN' and 'ATLAS-TENANT-NAME' respectively.

If no url is provived, the default https://atlas.linkconsulting.com/rest/login is used.