mtn-momo-client/src/tokens/createAccessToken.ts

A collection of utils to interact with the mtn-momo api

import { CreateTokenClientOptions, createTokenClient } from './client';

const EXPIRY_OFFSET = 30000; // 30 seconds

const expiresInToExpiresAt = (expiresIn: number): number =>
  Date.now() + expiresIn * 1000 - EXPIRY_OFFSET;

type CreateAccessTokenOptions = CreateTokenClientOptions;

type CreateAccessTokenRequestResponse = {
  access_token: string;
  token_type: string;
  expires_in: number;
};

type CreateAccessTokenResult = {
  /** The authentication token you will use to access other endpoints */
  accessToken: string;

  /** The  token type */
  tokenType: string;

  /** The validity time in seconds of the token. */
  expiresIn: number;

  /** The timestamp in milliseconds at which the token will expiry offset by 30 secs */
  expiresAt: number;
};

/**
 * Create an access token which can then be used to authorize and authenticate towards the other end-points of the API. Throws errors from the API when request is not successful
 * @param {CreateAccessTokenOptions} options the properties you need to create an access token
 * @returns {Promise<CreateAccessTokenResult>} the access token details
 */
const createAccessToken = async (
  options: CreateAccessTokenOptions
): Promise<CreateAccessTokenResult> => {
  const client = createTokenClient(options);
  const { data } = await client.post<CreateAccessTokenRequestResponse>(
    '/token/'
  );
  const expiresAt = expiresInToExpiresAt(data.expires_in);
  return {
    expiresAt,
    accessToken: data.access_token,
    tokenType: data.token_type,
    expiresIn: data.expires_in,
  };
};

export { createAccessToken, expiresInToExpiresAt };
export type { CreateAccessTokenResult, CreateAccessTokenOptions };