✨✨✨ NestJS Campay integration with full support of ALL CAMPAY OPERATIONS ✨✨✨
npm i nestjs-campay
Firstly, import module with CampayModule.forRoot(...)
or CampayModule.forRootAsync(...)
only once in root module (check out module configuration docs below):
import { CampayModule } from 'nestjs-campay';
@Module({
imports: [CampayModule.forRoot({
permanentAccessToken: 'my-secret-api-key',
isProduction: true
})],
})
class AppModule {}
Secondly, inject the Campay service into your service to perform operations:
import { CampayService } from 'nestjs-campay';
export class MyService {
constructor(private readonly campayService: CampayService) {}
collect() {
const res = await this.campayService.collect({
amount: 5000,
from: '2376xxxxxx',
description: 'Paying goods',
external_reference: 'xxx-xxx',
});
}
}
This module functions as a wrapper for the campay HTTP API. It inherits all constraints imposed by the campay HTTP API. For instance, in development mode (specified by the isProduction
property during module registration), limitations such as a maximum transfer amount of 100XAF apply.
The following interface is used for the configuration:
interface Params {
/**
* Optional parameter
* The campay permanentAccessToken.
*/
permanentAccessToken?: string;
/**
* Optional parameter for setting the application username. Should be set along with the password.
*
* Internally the username & password pair will be used to fetch an short-lived access token for performing calls to the Campay API
*/
username?: string;
/**
* Optional parameter for setting the application password. Should be set along with the username
*/
password?: string;
/**
* Optional parameter to set the module in production mode. Internally the correct campay base url will be determined based on this configuration.
*
* Default: false
*
*/
isProduction?: boolean;
/**
* Optional parameter to set the number of retries for refreshing the access token.
* Only needed if username and password are also provided.
*
* The refreshing could fail for various reasons as connection issues, temporary service outage, etc...
* **Note: **The refreshing will not be retried in case of wrong credentials.
*
* Default: 2
*
*/
nbRefreshTokenRetries?: number;
}
When the permanentAccessToken
is specified, authentication with the Campay API will utilize it. Otherwise, both the username
and password
options must be provided. Failure to provide either will result in an error being thrown during startup.
Use CampayModule.forRoot
method with argument of Params interface:
import { CampayModule } from 'nestjs-campay';
@Module({
imports: [
CampayModule.forRoot({
username: 'xxx-xxx',
password: 'super-secret-password',
})
],
...
})
class MyModule {}
With CampayModule.forRootAsync
you can, for example, import your ConfigModule
and inject ConfigService
to use it in useFactory
method.
useFactory
should return object with Params interface.
Here's an example:
import { CampayModule } from 'nestjs-campay';
@Injectable()
class ConfigService {
public readonly permanentAccessToken = 'campay-api-key-xxx-xxx';
public readonly isProduction = true;
}
@Module({
providers: [ConfigService],
exports: [ConfigService]
})
class ConfigModule {}
@Module({
imports: [
CampayModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
useFactory: async (config: ConfigService) => {
await somePromise();
return {
permanentAccessToken: config.permanentAccessToken,
isProduction: config.isProduction,
nbRefreshTokenRetries: 4
};
}
})
],
...
})
class MyModule {}
This package exposes a AXIOS_INSTANCE_TOKEN
token that can inject a custom axios implementation of type AxiosInstance
(from axios
package).
Using this token, you can provide a mock implementation of the axios instance using any of the standard custom provider techniques, including useClass
, useValue
and useFactory
.
const module: TestingModule = await Test.createTestingModule({
providers: [
...,
{
provide: AXIOS_INSTANCE_TOKEN,
useValue: axiosMock,
},
],
}).compile();