This package has been deprecated

Author message:

This package is deprecated and no longer maintained. Please use our new library https://www.npmjs.com/package/@decisionrules/decisionrules

@decisionrules/ng-decisionrules

ng-decisionrules

A simple Angular library that allows you to easily connect to Decisionrules.io from your web application.

Manual Installation

1. Installation

Install Decisionrules packages through npm:

npm install @decisionrules/ng-decisionrules

2. Generate API key

You can create your API key here: https://app.decisionrules.io/api-keys

3. Setup Angular Modules

Import the NgDecisionrulesModule into your Angular application's module AppModule. Your application's main module might look like this:

app.module.ts

import {BrowserModule} from '@angular/platform-browser';
import {NgModule} from '@angular/core';
import {AppRoutingModule} from './app-routing.module';
import {AppComponent} from './app.component';
import {NgDecisionrulesModule} from 'ng-decisionrules';
import {CustomDomainModel, ProtocolEnum} from "./customDomainModel";

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    NgDecisionrulesModule.forRoot({
      auth: {token: 'YOUR_API_KEY_HERE'},
      customDomain: new CustomDomainModel("custom domain url", ProtocolEnum.HTTPS);
      geoloc: {geoloc: 'PREFERED_GEOLOC_HERE'} // GEOLOC KEY-PAIR IS OPTIONAL - DEFAULT IS EU1 (Ireland)
    })
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule {
}

3.1 Custom domain init

If you are using custom domain you want to add CustomDomainModel to the NgDecisionrulesModule.forRoot

Object CustomDomainModel takes string domain name and ProtocolEnum enum value as mandatory params.

customDomain: new CustomDomainModel("your.domain.com", ProtocolEnum.HTTPS);

4. Solve rule

You can create rule on Decisionrules dashboard

app.component.ts

import {SolverStrategyEnum} from "./solverStrategyEnum";
import {SolverTypeEnum} from './SolverTypeEnum';

export class AppComponent implements OnInit {

  constructor(private decisionrulesService: NgDecisionrulesService) {
  }

  ngOnInit(): void {
    const inputData = {
      client: {
        age: 18
      }
    };
    this.decisionrulesService.solveRule(inputData, 'YOUR_RULE_ID', SolverStrategyEnum, SolverTypeEnum).then(data => {
      console.log(data);
    });
  }
}

Management API

Management api is accessible in NgDecisionrulesPublicService and requires management api key that you can obtain in api key section in DecisionRules app. Management api key is defined in config object auth: {managementToken: YOUR_TOKEN} in module import.

After defining constructor injection you can use all 6 management methods.

Each method returns promise.

import {NgDecisionrulesPublicService} from './ng-decisionrules.public.service';

export class AppComponent implements OnInit {

  constructor(private drManagement: NgDecisionrulesPublicService) {
  }

  async ngOnInit(): void {
      const spaceInfo = await this.drManagement.getRulesForSpace('SPACE_ID');
      const ruleInfo = await this.drManagement.getRuleById('RULE_ID');
      const ruleInfoVer = await this.drManagement.getRuleByIdAndVersion('RULE_ID', 'VERSION');
      // delete rule
      await this.drManagement.deleteRuleByRuleIdAndVersion('RULE_ID', 'VERSION');
      // post new rule
      await this.drManagement.createRuleForSpace('SPACE_ID', body);
      // update rule
      await this.drManagement.updateRuleByIdAndVersion('RULE_ID', 'VERSION', body);
  }
}