Dynamic GLSP - Server

On this package we had the server code.

Installation

$ npm install @eclipse-glsp/protocol @eclipse-glsp/server inversify @dynamic-glsp/protocol @dynamic-glsp/server

Usage

This package provides the custom server module and diagram module for dynamic diagram language support. You have to use it in a node server project to create a new GLSP server.

import {
  DynamicDiagramModule,
  DynamicServerModule,
  DynamicWebSocketServerLauncher,
  MessageConnectionAuth
} from '@dynamic-glsp/server';
import {
  SocketLaunchOptions,
  createAppModule,
  createSocketCliParser,
  defaultLaunchOptions} from '@eclipse-glsp/server/node';
import { Container } from 'inversify';

async launch() {
    // define container options
    const options = createSocketCliParser<SocketLaunchOptions>({
        ...defaultLaunchOptions,
        port: 3001, // port to listen
        host: '127.0.0.1' // host to listen
    }).parse();

    // create a new inversify container
    const container = new Container();

    // load a new GLSP app module
    container.load(createAppModule(options));

    // define services that GLSP needs to access the metamodels and models information
    // can use connectionAuth (auth, userAgent, ip) to validate user access
    const services = {
        languageProvider: async (languageID: string, connectionAuth: MessageConnectionAuth) => {
            // method for provide model language definition
            // can use any database or server logic here
        },
        modelProvider: async (modelID: string, connectionAuth: MessageConnectionAuth) => {
            // method for provide model data
            // can use any database or server logic here
        },
        modelSaver: async (modelID: string, model: any, preview: any, connectionAuth: MessageConnectionAuth) => {
            // method for save model data
            // can use any database or server logic here
        }
    };

    // create a GLSP Server Module with the Diagram Module (this will use a custom server module and diagram module for dynamic diagram language support)
    const serverModule = new DynamicServerModule().configureDiagramModule(new DynamicDiagramModule(services));

    // create a new DynamicWebSocketServerLauncher that allow authenticated communication using WebSocket
    const launcher = container.resolve(DynamicWebSocketServerLauncher);

    // configure the server module and start the server
    await launcher.configure(serverModule);
    await launcher.start({ port: options.port, host: options.host, path: 'dynamic' });
}

launch().catch((error) => console.error('Error in dynamic GLSP server:', error));

Overview

Dynamic GLSP is an instance of Graphical Language Server Platform (GLSP). It allows defining the model language through a meta-meta-model (or M2 model). This approach enables the dynamic generation of model elements data and graphics based on the language definition.

To achieve this, an extended generative GModel was created for graphical notation. Additionally, a new schema called AModel, based on JSON Schema, was developed for the model elements data. This schema is used to validate the model elements data and to generate the model elements data editor.