node package manager

ng2-alfresco-core

Alfresco Angular 2 Components core

travis
    Status travis
    Status Coverage Status npm downloads license alfresco component angular 2 typescript node version

Prerequisites

Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration, see this page.

Install

npm install --save ng2-alfresco-core

Main components and services

Components

  • Context Menu directive
  • Material Design directives
    • [mdl]
    • [alfresco-mdl-button]
    • [alfresco-mdl-menu]
    • [alfresco-mdl-tabs]

Services

  • LogService, log service implementation
  • NotificationService, Notification service implementation
  • AlfrescoApiService, provides access to Alfresco JS API instance
  • AlfrescoAuthenticationService, main authentication APIs
  • AlfrescoTranslationService, various i18n-related APIs
  • ContextMenuService, global context menu APIs

Alfresco Api Service

Provides access to initialized AlfrescoJSApi instance.

 
export class MyComponent implements OnInit {
 
    constructor(private apiService: AlfrescoApiService) {   
    }
 
    ngOnInit() {
        let nodeId = 'some-node-id';
        let params = {};
        this.getAlfrescoApi().nodes
            .getNodeChildren(nodeId, params)
            .then(result => console.log(result));
    }
}

Note for developers: the TypeScript declaration files for Alfresco JS API are still under development and some Alfresco APIs may not be accessed via your favourite IDE's intellisense or TypeScript compiler. In case of any TypeScript type check errors you can still call any supported Alfresco JS api by casting the instance to any type like the following:

let apiService: any = this.authService.getAlfrescoApi();
apiService.nodes.addNode('-root-', body, {});

Notification Service

The Notification Service is implemented on top of the Angular 2 Material Design snackbar. Use this service to show a notification message, and optionaly get feedback from it.

import { NotificationService } from 'ng2-alfresco-core';
 
export class MyComponent implements OnInit {
 
    constructor(private notificationService: NotificationService) {   
    }
 
    ngOnInit() {
          this.notificationService.openSnackMessage('test', 200000).afterDismissed().subscribe(() => {
                    console.log('The snack-bar was dismissed');
                });                        
    }
}
import { NotificationService } from 'ng2-alfresco-core';
 
export class MyComponent implements OnInit {
 
    constructor(private notificationService: NotificationService) {   
    }
 
    ngOnInit() {
         this.notificationService.openSnackMessageAction('Do you want to report this issue?', 'send', 200000).afterDismissed().subscribe(() => {
                console.log('The snack-bar was dismissed');
            });
    }
}

Context Menu directive

See Demo Shell or DocumentList implementation for more details and use cases.

<my-component [context-menu]="menuItems"></my-component>
<context-menu-holder></context-menu-holder>
@Component({
    selector: 'my-component
})
export class MyComponent implements OnInit {
 
    menuItems: any[];
    
    constructor() {
        this.menuItems = [
            { title: 'Item 1', subject: new Subject() },
            { title: 'Item 2', subject: new Subject() },
            { title: 'Item 3', subject: new Subject() }
        ];
    }
    
    ngOnInit() {
        this.menuItems.forEach(l => l.subject.subscribe(item => this.commandCallback(item)));
    }
    
    commandCallback(item) {
        alert(`Executing ${item.title} command.`);
    }
 
}

Authentication Service

The authentication service is used inside the login component and is possible to find there an example of how to use it.

import { NgModule, Component } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { CoreModule, AlfrescoSettingsService, AlfrescoAuthenticationService } from 'ng2-alfresco-core';
 
@Component({
    selector: 'alfresco-app-demo',
    template: `
        <div *ngIf="!authenticated" >
            Authentication failed to ip {{ ecmHost }} with user: admin, admin
        </div>
        <div *ngIf="authenticated">
            <H5>ECM</H5>
            Authentication successfull to ip {{ ecmHost }} with user: admin, admin<br> 
            your token is {{ tokenEcm }}<br>
            <H5>BPM</H5>
            Authentication successfull to ip {{ bpmHost }} with user: admin, admin<br> 
            your token is {{ tokenBpm }}<br>
        </div>
    `
})
class MyDemoApp {
    authenticated: boolean = false;
    ecmHost: string = 'http://localhost:8080';
    bpmHost: string = 'http://localhost:9999';
    tokenBpm: string;
    tokenEcm: string;
 
    constructor(public alfrescoAuthenticationService: AlfrescoAuthenticationService,
                private alfrescoSettingsService: AlfrescoSettingsService) {
 
        alfrescoSettingsService.ecmHost = this.ecmHost;
        alfrescoSettingsService.bpmHost = this.bpmHost;
 
        alfrescoSettingsService.setProviders('ALL');
    }
 
    ngOnInit() {
        this.login();
    }
 
    login() {
        this.alfrescoAuthenticationService.login('admin', 'admin').subscribe(
            token => {
                this.tokenBpm = this.alfrescoAuthenticationService.getTicketBpm();
                this.tokenEcm = this.alfrescoAuthenticationService.getTicketEcm();
                this.authenticated = true;
            },
            error => {
                console.log(error);
                this.authenticated = false;
            });
    }
}
 
@NgModule({
    imports: [
        BrowserModule,
        CoreModule.forRoot()
    ],
    declarations: [MyDemoApp],
    bootstrap: [MyDemoApp]
})
export class AppModule {
}
 
platformBrowserDynamic().bootstrapModule(AppModule);

AlfrescoTranslationService

In order to enable localisation support you will need creating a /resources/i18n/en.json file and registering path to it's parent i18n folder:

class MainApplication {
    constructor(private translateService: AlfrescoTranslationService) {
        translateService.addTranslationFolder('app', 'resources');
    }
}

Service also allows changing current language for entire application. Imagine you got a language picker that invokes onLanguageClicked method:

class MyComponent {
    constructor(private translateService: AlfrescoTranslationService) {
    }
 
    onLanguageClicked(lang: string) {
        this.translateService.use('en');
    }
}

It is also possible providing custom translations for existing components by overriding their resource paths:

class MyComponent {
    constructor(private translateService: AlfrescoTranslationService) {
        translateService.addTranslationFolder(
            'ng2-alfresco-login', 
            'i18n/custom-translation/alfresco-login'
        );
    }
}

Important note: addTranslationFolder method redirects all languages to a new folder, you may need implementing multiple languages or copying existing translation files to a new path.

Renditions Service

  • getRenditionsListByNodeId(nodeId: string)
  • createRendition(nodeId: string, encoding: string)
  • getRendition(nodeId: string, encoding: string)
  • isRenditionAvailable(nodeId: string, encoding: string)

Build from sources

Alternatively you can build component from sources with the following commands:

npm install
npm run build

Build from sources

Alternatively you can build component from sources with the following commands:

npm install
npm run build

Build the files and keep watching for changes

$ npm run build:w

Running unit tests

npm test

Running unit tests in browser

npm test-browser

This task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.

Code coverage

npm run coverage

NPM scripts

Command Description
npm run build Build component
npm run build:w Build component and keep watching the changes
npm run test Run unit tests in the console
npm run test-browser Run unit tests in the browser
npm run coverage Run unit tests and display code coverage report

License

Apache Version 2.0