@enfuce/nextgen-sdk 0.0.3 → 0.0.5

package/src/exchange-rate/common.ts

@@ -0,0 +1,127 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Exchange Rates API
+ * Endpoint for querying FX rates of payment scheme (including benchmark to ECB FX rates). API enables the issuer to comply with regulation (EU) 2019/518) and provide the cardholder with a better user experience by providing real-time visibility to scheme FX rates that are used for card transactions. 
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@enfuce.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey =>
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+}
+
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
+// @ts-ignore
+export const replaceWithSerializableTypeIfNeeded = function(key: string, value: any) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    } else {
+        return value;
+    }
+}
+
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
+        : (value || "");
+}
+
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/src/exchange-rate/configuration.ts

@@ -0,0 +1,121 @@
+/* tslint:disable */
+/**
+ * Exchange Rates API
+ * Endpoint for querying FX rates of payment scheme (including benchmark to ECB FX rates). API enables the issuer to comply with regulation (EU) 2019/518) and provide the cardholder with a better user experience by providing real-time visibility to scheme FX rates that are used for card transactions. 
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@enfuce.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface AWSv4Configuration {
+  options?: {
+    region?: string
+    service?: string
+  }
+  credentials?: {
+    accessKeyId?: string
+    secretAccessKey?: string,
+    sessionToken?: string
+  }
+}
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
+    }
+}

package/src/exchange-rate/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Exchange Rates API
+ * Endpoint for querying FX rates of payment scheme (including benchmark to ECB FX rates). API enables the issuer to comply with regulation (EU) 2019/518) and provide the cardholder with a better user experience by providing real-time visibility to scheme FX rates that are used for card transactions. 
+ *
+ * The version of the OpenAPI document: 1
+ * Contact: info@enfuce.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

package/src/index.ts

@@ -14,3 +14,4 @@ export * as threeds from './threeds';
 export * as threedsOob from './threeds-oob';
 export * as clearingFileCopy from './clearing-file-copy';
 export * as transactionEvent from './transaction-event';
+export * as exchangeRate from './exchange-rate';

package/src/oauth/axios.ts

@@ -19,19 +19,31 @@ function stripBearer(header: string): string {
 }
 
 /**
- * Returns an {@link AxiosInstance} with a response interceptor that, on a `401`,
- * forces a token refresh and retries the request exactly once with the new bearer
- * token. Pass it as the third argument of a generated API class:
+ * Returns an {@link AxiosInstance} with OAuth bearer-token handling built in:
+ *
+ * - **Proactive:** a request interceptor attaches a fresh bearer token (from the
+ *   {@link TokenManager}) to *every* request. This authenticates API modules whose spec declares no
+ *   security scheme (e.g. exchange-rate), so no `accessToken` on the `Configuration` is required.
+ * - **Reactive:** a response interceptor, on a `401`, forces a token refresh and retries the request
+ *   exactly once with the new bearer token.
+ *
+ * Pass it as the third argument of a generated API class:
  *
  * ```ts
  * const http = createOAuthAxios(tokens);
- * const config = new card.Configuration({ accessToken: () => tokens.getToken() });
+ * const config = new card.Configuration({ basePath });
  * const api = new card.CardApi(config, undefined, http);
  * ```
  */
 export function createOAuthAxios(manager: TokenManager, instance?: AxiosInstance): AxiosInstance {
     const http = instance ?? axios.create();
 
+    // Proactive: attach a fresh bearer token to every outgoing request.
+    http.interceptors.request.use(async (config) => {
+        config.headers.set('Authorization', BEARER_PREFIX + (await manager.getToken()));
+        return config;
+    });
+
     http.interceptors.response.use(undefined, async (error: AxiosError) => {
         const response = error.response;
         const original = error.config as RetriableConfig | undefined;

package/src/oauth/index.ts

@@ -13,10 +13,13 @@
  *     clientSecret: 'my-secret',
  *     scopes: ['cards:read'],
  *   });
- *   const http = oauth.createOAuthAxios(tokens);
- *   const config = new card.Configuration({ accessToken: () => tokens.getToken() });
+ *   const http = oauth.createOAuthAxios(tokens); // attaches the token + retries on 401
+ *   const config = new card.Configuration({ basePath: 'https://api.example.com' });
  *   const api = new card.CardApi(config, undefined, http);
  *
+ * The same `http` instance authenticates every API module, including ones whose spec declares no
+ * security scheme (e.g. exchange-rate) — no `accessToken` on the `Configuration` is required.
+ *
  * Server-side only — a client secret must never ship to a browser.
  */
 export { AccessToken, TokenFetcher, TokenManager } from './tokenManager';

package/test/oauth.test.ts

@@ -139,6 +139,25 @@ describe('clientCredentialsFetcher', () => {
 });
 
 describe('createOAuthAxios', () => {
+  it('proactively attaches a bearer token to a request that has no Authorization header', async () => {
+    const { fetch, calls } = countingFetcher();
+    const mgr = new TokenManager(fetch, 60, makeClock().now);
+
+    const seenAuth: (string | undefined)[] = [];
+    const adapter: AxiosAdapter = async (config) => {
+      seenAuth.push(config.headers?.Authorization as string | undefined);
+      return { data: { ok: true }, status: 200, statusText: 'OK', headers: {}, config };
+    };
+    const http = createOAuthAxios(mgr, axios.create({ adapter }));
+
+    // No Authorization header supplied — the SDK must attach one (as for a no-security-scheme spec).
+    const response = await http.request({ url: 'http://localhost/v1/ecb/currencies', method: 'get' });
+
+    expect(response.status).toBe(200);
+    expect(seenAuth).toEqual(['Bearer token-1']);
+    expect(calls.n).toBe(1);
+  });
+
   it('retries the request with a refreshed token when the first call rejects with 401', async () => {
     const { fetch } = countingFetcher();
     const mgr = new TokenManager(fetch, 60, makeClock().now);