Fluig API

Fluig API is an Angular service designed to simplify authentication and integration for Fluig platform applications, specifically for developers while developing locally, without the need to constantly build and push to a server to test the Angular app. It provides a wrapper for OAuth-based HTTP request authentication, and environment configuration.

Key Features

• OAuth Integration: Simplifies authentication using OAuth 1.0a.
• Environment-Specific Configurations: Easy switching between local and production environments.
• HTTP Request Handling: Provides pre-configured methods for GET, POST, DELETE, PUT, and PATCH.
• Token Management: Automatic injection of OAuth or Bearer authentication headers.

Pre-requisites and Dependencies

Ensure the following dependencies are installed:

• Node.js which includes Node Package Manager (or whatever package manager you prefer, like Yarn or PNPM)
• Angular (>= 19.x)

The package.json includes the additional peer dependencies:

"peerDependencies": {
  // ...
  "crypto-js": "^4.2.0",
  "oauth-1.0a": "^2.2.6"
}

Be sure to install these dependencies as devDependencies in your project.

PNPM

pnpm install -D crypto-js oauth-1.0a

NPM

npm install --save-dev crypto-js oauth-1.0a

Installation

To install Fluig API in your Angular project, execute the following command:

PNPM

pnpm install fluig-api

NPM

npm install fluig-api

Configuration

Environment Variables

Set up the environment.ts and environment.development.ts file:

// environment.development.ts
import { FluigAPIConfig } from 'fluig-api';

type Environment = Record<string, any> & { fluigAPI: FluigAPIConfig };

export const environment = {
  fluigAPI: {
    local: true, // enables token injection. In production, set this to false.
    debug: true,
    url: 'https://your-fluig-server.com',
    endpoints: ['/content-management', '/public', '/api', '/portal'],
    oauth: {
      consumerKey: 'consumer_key',
      consumerSecret: 'consumer_secret',
      accessToken: 'access_token',
      tokenSecret: 'token_secret',
    },
  },
};

For production, you need to disable local mode, as the app will be served from the Fluig server itself, which already handles authentication:

// environment.ts
import { FluigAPIConfig } from 'fluig-api';

type Environment = Record<string, any> & { fluigAPI: FluigAPIConfig };

export const environment = {
  fluigAPI: { local: false },
};

Angular Module Configuration

Add the FLUIG_API_CONFIG provider to your ApplicationConfig:

// app.config.ts
import { provideHttpClient, withInterceptors } from '@angular/common/http';

import { environment } from '../environments/environment';
import { provideFluigAPI, fluigAPIInterceptor } from 'fluig-api';

export const appConfig: ApplicationConfig = {
  providers: [
    // You must use `provideFluigAPI(config)`. This allows the package
    // to not use libraries like `crypto-js` and `oauth-1.0a` when not needed.
    provideFluigAPI(environment.fluigAPI),
    // Optionally add the interceptor to the HTTP client
    provideHttpClient(withInterceptors([fluigAPIInterceptor])),
  ],
};

Usage Example

Inject the FluigAPIService in your component or service:

import { Component, OnInit, inject } from '@angular/core';
import { HttpClient } from '@angular/common/http';
import { FluigAPIService } from 'fluig-api';

@Component({
  selector: 'app-root',
  templateUrl: './app.html',
  styleUrls: ['./app.css'],
})
export class App implements OnInit {
  private readonly http = inject(HttpClient);
  private readonly fluigAPI = inject(FluigAPIService);

  ngOnInit(): void {
    // Example API call using FluigAPIService
    // With this service, the OAuth headers are automatically added
    this.fluigAPI
      .get('/api/public/2.0/users/getCurrent')
      .subscribe((response) => console.log(response));

    // Example API call using `HttpClient` with `FluigAPI interceptor`.
    // The interceptor automatically adds the `OAuth` headers to the requests.
    // You might be better off using the `FluigAPIService` directly, though.
    // As you will need to manage the endpoints yourself in the environments config.
    this.http
      .get('/api/public/2.0/users/getCurrent')
      .subscribe((response) => console.log(response));
  }
}

Contributions

Contributions are welcome! Feel free to fork this repository and submit pull requests.

Contact Information

For issues or inquiries, please contact the repository owner:

• Author: Gabriel Nascimento
• GitHub: gabrielgnsilva
• Issues: Report Issues