# Model Server Typescript API ## Typescript Client API The model server project features a Typescript-based client API that eases integration with the Model Server. The interface declaration is as defined below. Please note that the `Model` class is a POJO with a model uri and content. ```typescript export interface ModelServerClient extends JsonRpcServer { initialize(): Promise; get(modeluri: URI, format?: string): Promise>; getAll(format?: string): Promise>; getModelUris(): Promise>; getElementById(modeluri: URI, elementid: string, format?: string): Promise>; getElementByName(modeluri: URI, elementname: string, format?: string): Promise>; delete(modeluri: URI): Promise>; update(modeluri: URI, newModel: any): Promise>; configure(configuration?: ServerConfiguration): Promise>; ping(): Promise>; undo(modeluri: URI): Promise>; redo(modeluri: URI): Promise>; save(modeluri: URI): Promise>; saveAll(): Promise>; getLaunchOptions(): Promise; edit(modeluri: URI, command: ModelServerCommand): Promise>; getTypeSchema(modeluri: URI): Promise>; getUiSchema(schemaName: string): Promise>; validation(modeluri: URI): Promise>; validationConstraints(modeluri: URI): Promise>; // WebSocket connection subscribe(modeluri: URI): void; subscribeWithValidation(modeluri: URI): void; subscribeWithFormat(modeluri: URI, format: string): void; subscribeWithTimeout(modeluri: URI, timeout: number): void; subscribeWithTimeoutAndFormat(modeluri: URI, timeout: number, format: string): void; sendKeepAlive(modeluri: URI): void; unsubscribe(modeluri: URI): void; } ``` ## Typescript API Examples ```typescript @inject(TheiaModelServerClient) protected readonly modelServerClient: TheiaModelServerClient; // perform simple GET this.modelServerClient.get('SuperBrewer3000.json') .then((response: Response) => this.messageService.info("GET: " + response.body())); // perform same GET, but expect an EObject this.modelServerClient.get('SuperBrewer3000.coffee', 'xmi') .then((response: Response) => this.messageService.info("GET XMI: " + response.body())); // perform GET ALL this.modelServerClient.getAll() .then((response: Response) => this.messageService.info("GET ALL: " + response.body())); // perform GET ELEMENT this.modelServerClient.getElementByName('SuperBrewer3000.json', 'Super Brewer 3000') .then((response: Response) => this.messageService.info("GET ELEMENT: " + response.body())); // perform ADD COMMAND (adds an AutomaticTask to the first Workflow and expects incremental update) const owner = { 'eClass': 'http://www.eclipsesource.com/modelserver/example/coffeemodel#//Workflow', '$ref': `${this.workspaceUri}/SuperBrewer3000.json#//@workflows.0` }; const feature = 'nodes'; const toAdd = [ { eClass: 'http://www.eclipsesource.com/modelserver/example/coffeemodel#//AutomaticTask' } ]; const addCommand = new AddCommand(owner, feature, toAdd); this.modelServerClient.edit('SuperBrewer3000.json', addCommand) .then((response: any) => this.messageService.info("INCREMENTAL UPDATE: " + response.body())); // perform UNDO this.modelServerClient.undo('SuperBrewer3000.json') .then((response: any) => this.messageService.info("INCREMENTAL UPDATE AFTER UNDO: " + response.body())); // subscribe this.modelServerClient.subscribe('SuperBrewer3000.json'); // unsubscribe this.modelServerClient.unsubscribe('SuperBrewer3000.json'); ```

@eclipse-emfcloud/modelserver-theia