# @openiap/ng-openflow-auth

> 1) Install NgOpenflowAuth angular-oauth2-oidc and @openiap/openflow-api

Latest version **0.0.13** (published 2022-09-20) · 0 weekly downloads

## Install

```sh
npm install @openiap/ng-openflow-auth
pnpm add @openiap/ng-openflow-auth
yarn add @openiap/ng-openflow-auth
bun add @openiap/ng-openflow-auth
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.13 |
| Published | 2022-09-20 |
| First published | 2021-02-20 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 159 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | skadefro |

## Links

- npm: https://www.npmjs.com/package/@openiap/ng-openflow-auth
- npm.io page: https://npm.io/package/@openiap/ng-openflow-auth

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.0.0

## Recent versions

- 0.0.13 (latest) — 2022-09-20
- 0.0.12 — 2022-09-20
- 0.0.11 — 2021-05-16
- 0.0.10 — 2021-05-10
- 0.0.9 — 2021-05-07
- 0.0.8 — 2021-05-06
- 0.0.7 — 2021-05-06
- 0.0.6 — 2021-02-22
- 0.0.5 — 2021-02-21
- 0.0.4 — 2021-02-21
- 0.0.3 — 2021-02-21
- 0.0.2 — 2021-02-21
- 0.0.1 — 2021-02-20

## README

# NgOpenflowAuth

1) Install NgOpenflowAuth angular-oauth2-oidc and @openiap/openflow-api

``` npm i @openiap/ng-openflow-auth angular-oauth2-oidc @openiap/openflow-api``` 

2) Add Configuration file for oauth2-oidc and NgOpenflowAuth 
Under src/app add a new file called authCodeFlowConfig.ts 

```javascript
import { AuthConfig } from 'angular-oauth2-oidc';
const domain:string = "app.openiap.io";
export const api_wsurl: string = "wss://" + domain;
export const authCodeFlowConfig: AuthConfig = {
    issuer: "https://" + domain + "/oidc",
    redirectUri: window.location.origin,
    responseType: 'code',
    clientId: 'myngapp',
    scope: 'openid profile email'
};
```

3) Tell angular to ignore the npm modules used by @openiap/openflow-api
Open package.json and add a browser section

```json
  "browser": {
    "fs": false,
    "path": false,
    "crypto": false
  },
```

4) Register angular-oauth2-oidc and HttpClientModule
open app.module.ts and add

```javascript
// Add imports
import { OAuthModule } from 'angular-oauth2-oidc';
import { api_wsurl, authCodeFlowConfig } from './authCodeFlowConfig';
import { HttpClientModule } from '@angular/common/http';
// Add to @NgModule
@NgModule({
	declarations: [],
	imports: [
        HttpClientModule,
		OAuthModule.forRoot()
	],
	providers: [
        {provide: 'apiwsurl', useValue: api_wsurl},
        {provide: 'authCodeFlowConfig', useValue: authCodeFlowConfig}
	],
	bootstrap: []
})


```

5) In any component you want to check if the user has been signed in, get data.
Add this to the component.ts file

```javascript
// Add imports
import { NgOpenflowAuthService } from '@openiap/ng-openflow-auth';

export class UsersComponent implements OnInit {
    // Add NgOpenflowAuthService as an injected service in the constructor
    constructor(
        public openflowAuthService: NgOpenflowAuthService
      ) { }

    // Create place holder for users
    public users: any[] = [];
    // Then in add a callback doing the sigin event, 
    ngOnInit(): void {
        this.openflowAuthService.onSignedin(async user=> {
            console.log("Signed in as " + user.name);
            try {
                // Get list of all users in openflow
                this.users = await NoderedUtil.Query("users", {"_type": "user"}, null, null, 100, 0, null as any);
            } catch (error) {
                console.error(error);
            }
        });
    }
}
```

6) And to allow the user to sign in/sing out and see the list add  this to the html page

```html
<button *ngIf="!openflowAuthService.isSignedIn" (click)="openflowAuthService.Login()">Login</button>
<button *ngIf="openflowAuthService.isSignedIn" (click)="openflowAuthService.Logout()">Logout</button>
<div *ngIf="openflowAuthService.isSignedIn">
    <h2>Users</h2>
    <li *ngFor="let item of users">
        <span class="badge">{{item._type}}</span>: {{item.name}}
    </li>
</div>
```

---
_Source: https://npm.io/package/@openiap/ng-openflow-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
