@oapiex/sdk-kit 0.1.2 → 0.1.4

package/dist/index.js

@@ -64,15 +64,53 @@ const buildUrl = (baseUrl, ...endpoint) => {
 	return (baseUrl + path.normalize(path.join(...normalizeValue(endpoint)))).replace(/([^:]\/)\/+/g, "$1");
 };
 
+//#endregion
+//#region src/utilities/Manager.ts
+const defaultConfig = {
+	environment: "sandbox",
+	urls: {
+		live: "",
+		sandbox: ""
+	},
+	headers: {}
+};
+let globalConfig = defaultConfig;
+const defineConfig = (config) => {
+	const baseConfig = globalConfig ?? defaultConfig;
+	const userConfig = {
+		...baseConfig,
+		...config,
+		urls: config.urls ? {
+			...baseConfig.urls ?? defaultConfig.urls,
+			...config.urls
+		} : baseConfig.urls,
+		headers: config.headers ? {
+			...baseConfig.headers ?? defaultConfig.headers,
+			...config.headers
+		} : baseConfig.headers
+	};
+	globalConfig = userConfig;
+	return userConfig;
+};
+const getConfig = () => globalConfig;
+const resetConfig = () => {
+	globalConfig = {
+		...defaultConfig,
+		urls: { ...defaultConfig.urls ?? {} },
+		headers: { ...defaultConfig.headers ?? {} }
+	};
+	return globalConfig;
+};
+
 //#endregion
 //#region src/Builder.ts
 var Builder = class {
 	static baseUrls = {
-		live: "https://api.flutterwave.com/v4/",
-		sandbox: "https://developersandbox-api.flutterwave.com/"
+		live: "",
+		sandbox: ""
 	};
 	/**
-	* Flutterwave Environment
+	* API Environment
 	*/
 	static environment;
 	constructor() {}
@@ -90,8 +128,11 @@ var Builder = class {
 	* @returns 
 	*/
 	static baseUrl() {
-		if ((process.env.ENVIRONMENT || this.environment || "sandbox") === "live") return this.baseUrls.live;
-		return this.baseUrls.sandbox;
+		const config = getConfig();
+		const env = this.environment ?? config.environment ?? this.normalizeEnvironment(process.env.ENVIRONMENT) ?? "sandbox";
+		const configuredUrl = config.urls?.[env];
+		if (configuredUrl) return this.normalizeBaseUrl(configuredUrl);
+		return this.normalizeBaseUrl(this.baseUrls[env]);
 	}
 	/**
 	* Builds a full url based on endpoint provided
@@ -166,10 +207,12 @@ var Builder = class {
 	* @returns                 A new object with the specified keys encrypted.
 	*/
 	static async encryptDetails(input, keysToEncrypt = [], outputMapping = {}) {
+		const encryptionKey = getConfig().encryptionKey ?? process.env.ENCRYPTION_KEY;
+		if (!encryptionKey) throw new Error("Encryption key is required to encrypt details");
 		const nonce = crypto.randomBytes(12).toString("base64").slice(0, 12);
 		const encryptableKeys = keysToEncrypt.length > 0 ? keysToEncrypt : Object.keys(input);
 		const encrypted = Object.fromEntries(Object.entries(input).map(([key, value]) => {
-			if (encryptableKeys.includes(key) && typeof value === "string") return [outputMapping?.[key] || key, this.encryptAES(value, process.env.ENCRYPTION_KEY, nonce)];
+			if (encryptableKeys.includes(key) && typeof value === "string") return [outputMapping?.[key] || key, this.encryptAES(value, encryptionKey, nonce)];
 			return [key, value];
 		}));
 		for (const key of encryptableKeys) delete input[key];
@@ -195,6 +238,10 @@ var Builder = class {
 		}, key, new TextEncoder().encode(data));
 		return btoa(String.fromCharCode(...new Uint8Array(encryptedData)));
 	}
+	static normalizeBaseUrl = (url) => url.endsWith("/") ? url : `${url}/`;
+	static normalizeEnvironment = (value) => {
+		if (value === "live" || value === "sandbox") return value;
+	};
 };
 
 //#endregion
@@ -342,13 +389,41 @@ var Http = class Http {
 	*/
 	static setBearerToken(token) {
 		this.bearerToken = token;
+		defineConfig({ auth: {
+			type: "bearer",
+			token
+		} });
+	}
+	static setAuth(auth) {
+		defineConfig({ auth });
+	}
+	static setBasicAuth(username, password) {
+		this.setAuth({
+			type: "basic",
+			username,
+			password
+		});
+	}
+	static setApiKey(name, value, location = "header", prefix) {
+		this.setAuth({
+			type: "apiKey",
+			name,
+			value,
+			in: location,
+			prefix
+		});
+	}
+	static clearAuth() {
+		this.bearerToken = void 0;
+		defineConfig({ auth: void 0 });
 	}
 	setDefaultHeaders(defaults) {
+		const config = getConfig();
 		this.headers = {
 			...defaults,
+			...config.headers ?? {},
 			...this.headers
 		};
-		if (Http.bearerToken) this.headers.Authorization = `Bearer ${Http.bearerToken}`;
 	}
 	getHeaders() {
 		return this.headers;
@@ -357,13 +432,15 @@ var Http = class Http {
 		return this.body;
 	}
 	axiosApi() {
+		const config = getConfig();
 		this.setDefaultHeaders({
 			"Accept": "application/json",
 			"Content-Type": "application/json"
 		});
 		const instance = axios.create({
 			baseURL: Builder.baseUrl(),
-			headers: this.getHeaders()
+			headers: this.getHeaders(),
+			timeout: config.timeout
 		});
 		if (Http.debugLevel > 0) {
 			instance.interceptors.request.use((request) => {
@@ -416,11 +493,18 @@ var Http = class Http {
 	*/
 	static async send(url, method, body, headers = {}, params) {
 		try {
-			const { data } = await new Http(headers).axiosApi()({
+			const request = await this.prepareRequest({
 				url,
 				method,
-				data: body,
-				params
+				body,
+				headers: this.toHeaderRecord(headers),
+				params: { ...params ?? {} }
+			});
+			const { data } = await new Http(request.headers, request.body).axiosApi()({
+				url: request.url,
+				method: request.method,
+				data: request.body,
+				params: request.params
 			});
 			return {
 				success: true,
@@ -433,6 +517,71 @@ var Http = class Http {
 			throw this.exception(e.response?.status ?? 500, error || e, e);
 		}
 	}
+	static async prepareRequest(request) {
+		let prepared = {
+			...request,
+			headers: { ...request.headers },
+			params: { ...request.params ?? {} }
+		};
+		for (const auth of this.getConfiguredAuth()) prepared = await this.applyAuth(prepared, auth);
+		return prepared;
+	}
+	static getConfiguredAuth() {
+		const configuredAuth = getConfig().auth;
+		if (configuredAuth) return Array.isArray(configuredAuth) ? configuredAuth : [configuredAuth];
+		if (this.bearerToken) return [{
+			type: "bearer",
+			token: this.bearerToken
+		}];
+		return [];
+	}
+	static async applyAuth(request, auth) {
+		switch (auth.type) {
+			case "bearer":
+				this.setHeaderIfMissing(request.headers, "Authorization", `${auth.prefix ?? "Bearer"} ${auth.token}`.trim());
+				return request;
+			case "oauth2":
+				this.setHeaderIfMissing(request.headers, "Authorization", `${auth.tokenType ?? "Bearer"} ${auth.accessToken}`.trim());
+				return request;
+			case "basic": {
+				const encoded = Buffer.from(`${auth.username}:${auth.password}`).toString("base64");
+				this.setHeaderIfMissing(request.headers, "Authorization", `Basic ${encoded}`);
+				return request;
+			}
+			case "apiKey": {
+				const value = auth.prefix ? `${auth.prefix} ${auth.value}`.trim() : auth.value;
+				const location = auth.in ?? "header";
+				if (location === "query") {
+					if (request.params[auth.name] === void 0) request.params[auth.name] = value;
+					return request;
+				}
+				if (location === "cookie") {
+					this.appendCookie(request.headers, auth.name, value);
+					return request;
+				}
+				this.setHeaderIfMissing(request.headers, auth.name, value);
+				return request;
+			}
+			case "custom": return await auth.apply({
+				...request,
+				headers: { ...request.headers },
+				params: { ...request.params }
+			});
+		}
+	}
+	static setHeaderIfMissing(headers, name, value) {
+		if (!Object.keys(headers).find((header) => header.toLowerCase() === name.toLowerCase())) headers[name] = value;
+	}
+	static appendCookie(headers, name, value) {
+		const headerName = Object.keys(headers).find((header) => header.toLowerCase() === "cookie") ?? "Cookie";
+		const existingCookie = headers[headerName];
+		const cookieEntry = `${encodeURIComponent(name)}=${encodeURIComponent(value)}`;
+		if (!existingCookie) {
+			headers[headerName] = cookieEntry;
+			return;
+		}
+		if (!existingCookie.split(";").map((part) => part.trim()).some((part) => part.startsWith(`${encodeURIComponent(name)}=`))) headers[headerName] = `${existingCookie}; ${cookieEntry}`;
+	}
 	/**
 	* Create an HttpException from status and error
 	* 
@@ -457,13 +606,16 @@ var Http = class Http {
 		if (this.apiInstance) this.apiInstance.setLastException(exception);
 		return exception;
 	}
+	static toHeaderRecord = (headers) => {
+		return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, String(value)]));
+	};
 };
 
 //#endregion
 //#region src/Apis/BaseApi.ts
 var BaseApi = class {
 	/**
-	* Flutterwave instance
+	* API Core instance for API bootstrapping and shared utilities
 	*/
 	#core;
 	lastException;
@@ -569,7 +721,7 @@ const toRecord = (value) => {
 
 //#endregion
 //#region src/Core.ts
-var Core = class {
+var Core = class Core {
 	static apiClass = BaseApi;
 	debugLevel = 0;
 	/**
@@ -581,7 +733,7 @@ var Core = class {
 	*/
 	clientSecret;
 	/**
-	* Flutterwave Environment
+	* API Environment
 	*/
 	environment = "live";
 	accessValidator;
@@ -593,25 +745,46 @@ var Core = class {
 	* Builder Instance
 	*/
 	builder = Builder;
-	constructor(clientId, clientSecret, encryptionKey, env) {
+	constructor(clientId, clientSecret, encryptionKey, env, config) {
+		const currentConfig = getConfig();
 		if (typeof clientId === "object") {
 			this.clientId = clientId.clientId;
 			this.clientSecret = clientId.clientSecret;
-			this.environment = clientId.environment ?? "live";
+			this.environment = clientId.environment ?? currentConfig.environment ?? Core.normalizeEnvironment(process.env.ENVIRONMENT) ?? "live";
+			this.configure({
+				environment: this.environment,
+				urls: clientId.urls,
+				headers: clientId.headers,
+				timeout: clientId.timeout,
+				encryptionKey: clientId.encryptionKey,
+				auth: clientId.auth
+			});
 		} else {
 			this.clientId = clientId ?? process.env.CLIENT_ID ?? "";
 			this.clientSecret = clientSecret ?? process.env.CLIENT_SECRET ?? "";
-			this.environment = env ?? process.env.ENVIRONMENT ?? "live";
+			this.environment = env ?? currentConfig.environment ?? Core.normalizeEnvironment(process.env.ENVIRONMENT) ?? "live";
+			this.configure({
+				...config ?? {},
+				environment: this.environment,
+				encryptionKey: encryptionKey ?? config?.encryptionKey
+			});
 		}
-		if (!this.clientId || !this.clientSecret) throw new Error("Client ID and Client Secret are required to initialize Flutterwave instance");
-		this.builder.setEnvironment(this.environment);
+		if (!this.clientId || !this.clientSecret) throw new Error("Client ID and Client Secret are required to initialize API instance");
 		this.api = this.createApi();
 	}
 	createApi() {
 		return (this.constructor.apiClass ?? BaseApi).initialize(this);
 	}
-	init(clientId, clientSecret, encryptionKey, env) {
-		return new this.constructor(clientId, clientSecret, encryptionKey, env);
+	init(clientId, clientSecret, encryptionKey, env, config) {
+		return new this.constructor(clientId, clientSecret, encryptionKey, env, config);
+	}
+	configure(config) {
+		const nextConfig = defineConfig(config);
+		if (nextConfig.environment) {
+			this.environment = nextConfig.environment;
+			this.builder.setEnvironment(nextConfig.environment);
+		}
+		return this;
 	}
 	/**
 	* Set the debug level
@@ -633,12 +806,44 @@ var Core = class {
 		return this.environment;
 	}
 	/**
+	* Get the configured client identifier.
+	*/
+	getClientId() {
+		return this.clientId;
+	}
+	/**
+	* Get the configured client secret.
+	*/
+	getClientSecret() {
+		return this.clientSecret;
+	}
+	/**
+	* Get the current shared SDK config.
+	*/
+	getConfig() {
+		return getConfig();
+	}
+	/**
+	* Replace the active auth strategy.
+	*/
+	setAuth(auth) {
+		return this.configure({ auth });
+	}
+	/**
+	* Clear any configured auth strategy.
+	*/
+	clearAuth() {
+		Http.clearAuth();
+		return this;
+	}
+	/**
 	* Set access validator function
 	* 
 	* @param validator Function to validate access
 	*/
 	setAccessValidator(validator) {
 		this.accessValidator = validator;
+		return this;
 	}
 	/**
 	* Validates access using the provided access validator function
@@ -647,7 +852,16 @@ var Core = class {
 	*/
 	async validateAccess() {
 		const check = this.accessValidator ? await this.accessValidator(this) : true;
-		if (check !== true) throw new Error(typeof check === "string" ? check : "Access validation failed");
+		if (check === true || check == null) return;
+		if (this.isAuthConfigOrArray(check)) {
+			this.setAuth(check);
+			return;
+		}
+		if (this.isConfigUpdate(check)) {
+			this.configure(check);
+			return;
+		}
+		throw new Error(typeof check === "string" ? check : "Access validation failed");
 	}
 	/**
 	* Use a manifest bundle to create the API instance
@@ -668,29 +882,61 @@ var Core = class {
 	useSdk(bundle) {
 		return this.useDocument(bundle);
 	}
+	static normalizeEnvironment = (value) => {
+		if (value === "live" || value === "sandbox") return value;
+	};
+	isAuthConfigOrArray(value) {
+		if (Array.isArray(value)) return value.every((entry) => this.isAuthConfig(entry));
+		return this.isAuthConfig(value);
+	}
+	isAuthConfig(value) {
+		return typeof value === "object" && value !== null && "type" in value && typeof value.type === "string";
+	}
+	isConfigUpdate(value) {
+		if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+		return [
+			"auth",
+			"environment",
+			"headers",
+			"timeout",
+			"urls",
+			"encryptionKey"
+		].some((key) => key in value);
+	}
 };
 
 //#endregion
-//#region src/utilities/Manager.ts
-const defaultConfig = {
-	environment: "sandbox",
-	urls: {
-		live: "",
-		sandbox: ""
-	}
-};
-let globalConfig = defaultConfig;
-const defineConfig = (config) => {
-	const userConfig = {
-		...defaultConfig,
-		...config,
-		urls: {
-			...defaultConfig.urls,
-			...config.urls
-		}
+//#region src/utilities/AuthCache.ts
+/**
+* Cache any auth payload returned from a loader until it expires.
+*/
+const createAuthCache = (loader) => {
+	let cached;
+	return async (core) => {
+		if (cached && !isExpired(cached.expiresAt)) return cached.auth;
+		cached = await loader(core);
+		return cached.auth;
 	};
-	globalConfig = userConfig;
-	return userConfig;
+};
+/**
+* Cache bearer or oauth-style access tokens returned from a loader until expiry.
+*/
+const createAccessTokenCache = (loader) => {
+	return createAuthCache(async (core) => {
+		const token = await loader(core);
+		const expiresAt = token.expiresAt ?? (typeof token.expiresInMs === "number" ? Date.now() + token.expiresInMs : typeof token.expiresInSeconds === "number" ? Date.now() + token.expiresInSeconds * 1e3 : void 0);
+		return {
+			auth: {
+				type: "oauth2",
+				accessToken: token.token,
+				tokenType: token.tokenType ?? "Bearer"
+			},
+			expiresAt
+		};
+	});
+};
+const isExpired = (expiresAt) => {
+	return typeof expiresAt === "number" && expiresAt <= Date.now();
 };
 
 //#endregion
@@ -753,4 +999,4 @@ var WebhookValidator = class {
 };
 
 //#endregion
-export { BadRequestException, BaseApi, Builder, Core, ForbiddenRequestException, Http, HttpException, UnauthorizedRequestException, WebhookValidator, buildUrl, createRuntimeApi, createSdk, defaultConfig, defineConfig, globalConfig, normalizeValue };
+export { BadRequestException, BaseApi, Builder, Core, ForbiddenRequestException, Http, HttpException, UnauthorizedRequestException, WebhookValidator, buildUrl, createAccessTokenCache, createAuthCache, createRuntimeApi, createSdk, defaultConfig, defineConfig, getConfig, globalConfig, normalizeValue, resetConfig };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oapiex/sdk-kit",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A TypeScript Base for building SDKs using OpenAPI specifications extracted by OAPIEX.",
   "main": "./dist/index.cjs",
   "private": false,