@oapiex/sdk-kit 0.1.5 → 0.1.8

package/README.md

@@ -134,14 +134,15 @@ await sdk.api.examples.list();
 
 `Core` and `createSdk()` both accept the same `InitOptions` object.
 
-- `clientId`: required API client identifier
-- `clientSecret`: required API client secret
+- `clientId`: optional API client identifier, useful when your validator or auth exchange still needs client credentials
+- `clientSecret`: optional when `auth` is already provided, otherwise required
 - `environment`: selects `sandbox` or `live`
 - `urls`: optional base URL overrides per environment
 - `headers`: optional default headers added to every request
 - `timeout`: optional Axios timeout in milliseconds
 - `encryptionKey`: optional runtime encryption key override
 - `auth`: one auth strategy or an array of strategies applied to outgoing requests
+- `debugLevel`: optional HTTP debug verbosity, one of `0 | 1 | 2 | 3`
 
 ```ts
 const sdk = new Core({
@@ -156,9 +157,98 @@ const sdk = new Core({
     'X-Trace-Source': 'example-sdk',
   },
   timeout: 15000,
+  debugLevel: 1,
 });
 ```
 
+If you already have a token or API key strategy, you can initialize without client credentials:
+
+```ts
+const sdk = new Core({
+  environment: 'sandbox',
+  auth: {
+    type: 'bearer',
+    token: process.env.ACCESS_TOKEN!,
+  },
+  debugLevel: 1,
+});
+```
+
+`@oapiex/sdk-kit` can also read SDK init config from `oapiex.config.ts`, `oapiex.config.js`, or `oapiex.config.cjs` in the current working directory.
+
+For an SDK-focused config file, prefer `defineConfig()` from `@oapiex/sdk-kit`:
+
+```ts
+import { defineConfig } from '@oapiex/sdk-kit';
+
+export default defineConfig({
+  clientId: process.env.CLIENT_ID,
+  clientSecret: process.env.CLIENT_SECRET,
+  environment: 'sandbox',
+  urls: {
+    sandbox: 'https://sandbox-api.example.com',
+  },
+  headers: {
+    'X-Trace-Source': 'example-sdk',
+  },
+  timeout: 15000,
+  auth: {
+    type: 'bearer',
+    token: process.env.ACCESS_TOKEN,
+  },
+  debugLevel: 1,
+});
+```
+
+If you use the same `oapiex.config.*` file for extraction and SDK runtime defaults, prefer the root `oapiex` helper and scope the SDK settings under `sdkKit`:
+
+```ts
+import { defineConfig } from 'oapiex';
+
+export default defineConfig({
+  sdkKit: {
+    clientId: process.env.CLIENT_ID,
+    clientSecret: process.env.CLIENT_SECRET,
+    environment: 'sandbox',
+    urls: {
+      sandbox: 'https://sandbox-api.example.com',
+    },
+    headers: {
+      'X-Trace-Source': 'example-sdk',
+    },
+    timeout: 15000,
+    auth: {
+      type: 'bearer',
+      token: process.env.ACCESS_TOKEN,
+    },
+    debugLevel: 1,
+  },
+});
+```
+
+Explicit constructor options override values loaded from `oapiex.config.*`.
+
+## Debugging
+
+SDK HTTP debugging is disabled by default.
+
+- Use `sdk.debug(level)` after initialization when you want to enable or adjust request logging.
+- Use `debugLevel` in `InitOptions` when you want debug logging active immediately during construction.
+- Supported levels are `0 | 1 | 2 | 3`.
+
+```ts
+const sdk = new Core({
+  environment: 'sandbox',
+  auth: {
+    type: 'bearer',
+    token: process.env.ACCESS_TOKEN!,
+  },
+  debugLevel: 2,
+});
+
+sdk.debug(3);
+```
+
 ## Auth Shapes
 
 The `auth` option accepts any `AuthConfig` supported by the transport layer.

package/dist/chunk-BLWcukCW.js

@@ -0,0 +1,33 @@
+import { createRequire } from "node:module";
+
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __esm = (fn, res) => function() {
+	return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function() {
+	return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+
+//#endregion
+export { __toESM as i, __esm as n, __require as r, __commonJS as t };

package/dist/chunk-BncF-t-1.cjs

@@ -0,0 +1,48 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __esm = (fn, res) => function() {
+	return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function() {
+	return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__commonJS', {
+  enumerable: true,
+  get: function () {
+    return __commonJS;
+  }
+});
+Object.defineProperty(exports, '__esm', {
+  enumerable: true,
+  get: function () {
+    return __esm;
+  }
+});
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/contracts.d.cts

@@ -1,2 +1,2 @@
-import { A as CurrencyCode, C as UserConfig, D as XGenericObject, E as ValidationErrorResponse, O as CountryCode, S as UnifiedResponse, T as ValidationError, _ as OAuth2AuthConfig, a as AuthErrorResponse, b as ResponseStatus, c as BasicAuthConfig, d as CustomAuthConfig, f as Environment, g as NormalPagination, h as InitOptions, i as AuthConfig, k as CountryCodeRestricted, l as BearerAuthConfig, m as HttpMethod, n as AccessValidationResult, o as AuthRequestConfig, p as ErrorResponse, r as ApiKeyAuthConfig, s as AuthResponse, t as AccessValidationConfigUpdate, u as CursorPagination, v as PageInfoMeta, w as UserUrls, x as SuccessResponse, y as Response } from "./index-JjhthUpt.cjs";
-export { AccessValidationConfigUpdate, AccessValidationResult, ApiKeyAuthConfig, AuthConfig, AuthErrorResponse, AuthRequestConfig, AuthResponse, BasicAuthConfig, BearerAuthConfig, CountryCode, CountryCodeRestricted, CurrencyCode, CursorPagination, CustomAuthConfig, Environment, ErrorResponse, HttpMethod, InitOptions, NormalPagination, OAuth2AuthConfig, PageInfoMeta, Response, ResponseStatus, SuccessResponse, UnifiedResponse, UserConfig, UserUrls, ValidationError, ValidationErrorResponse, XGenericObject };
+import { A as CountryCodeRestricted, C as UnifiedResponse, D as ValidationErrorResponse, E as ValidationError, O as XGenericObject, S as SuccessResponse, T as UserUrls, _ as NormalPagination, a as AuthErrorResponse, b as Response, c as BasicAuthConfig, d as CustomAuthConfig, f as DebugLevel, g as InitOptions, h as HttpMethod, i as AuthConfig, j as CurrencyCode, k as CountryCode, l as BearerAuthConfig, m as ErrorResponse, n as AccessValidationResult, o as AuthRequestConfig, p as Environment, r as ApiKeyAuthConfig, s as AuthResponse, t as AccessValidationConfigUpdate, u as CursorPagination, v as OAuth2AuthConfig, w as UserConfig, x as ResponseStatus, y as PageInfoMeta } from "./index-BA7Ul1Pi.cjs";
+export { AccessValidationConfigUpdate, AccessValidationResult, ApiKeyAuthConfig, AuthConfig, AuthErrorResponse, AuthRequestConfig, AuthResponse, BasicAuthConfig, BearerAuthConfig, CountryCode, CountryCodeRestricted, CurrencyCode, CursorPagination, CustomAuthConfig, DebugLevel, Environment, ErrorResponse, HttpMethod, InitOptions, NormalPagination, OAuth2AuthConfig, PageInfoMeta, Response, ResponseStatus, SuccessResponse, UnifiedResponse, UserConfig, UserUrls, ValidationError, ValidationErrorResponse, XGenericObject };

package/dist/contracts.d.ts

@@ -1,2 +1,2 @@
-import { A as CurrencyCode, C as UserConfig, D as XGenericObject, E as ValidationErrorResponse, O as CountryCode, S as UnifiedResponse, T as ValidationError, _ as OAuth2AuthConfig, a as AuthErrorResponse, b as ResponseStatus, c as BasicAuthConfig, d as CustomAuthConfig, f as Environment, g as NormalPagination, h as InitOptions, i as AuthConfig, k as CountryCodeRestricted, l as BearerAuthConfig, m as HttpMethod, n as AccessValidationResult, o as AuthRequestConfig, p as ErrorResponse, r as ApiKeyAuthConfig, s as AuthResponse, t as AccessValidationConfigUpdate, u as CursorPagination, v as PageInfoMeta, w as UserUrls, x as SuccessResponse, y as Response } from "./index-DUI9uPJQ.js";
-export { AccessValidationConfigUpdate, AccessValidationResult, ApiKeyAuthConfig, AuthConfig, AuthErrorResponse, AuthRequestConfig, AuthResponse, BasicAuthConfig, BearerAuthConfig, CountryCode, CountryCodeRestricted, CurrencyCode, CursorPagination, CustomAuthConfig, Environment, ErrorResponse, HttpMethod, InitOptions, NormalPagination, OAuth2AuthConfig, PageInfoMeta, Response, ResponseStatus, SuccessResponse, UnifiedResponse, UserConfig, UserUrls, ValidationError, ValidationErrorResponse, XGenericObject };
+import { A as CountryCodeRestricted, C as UnifiedResponse, D as ValidationErrorResponse, E as ValidationError, O as XGenericObject, S as SuccessResponse, T as UserUrls, _ as NormalPagination, a as AuthErrorResponse, b as Response, c as BasicAuthConfig, d as CustomAuthConfig, f as DebugLevel, g as InitOptions, h as HttpMethod, i as AuthConfig, j as CurrencyCode, k as CountryCode, l as BearerAuthConfig, m as ErrorResponse, n as AccessValidationResult, o as AuthRequestConfig, p as Environment, r as ApiKeyAuthConfig, s as AuthResponse, t as AccessValidationConfigUpdate, u as CursorPagination, v as OAuth2AuthConfig, w as UserConfig, x as ResponseStatus, y as PageInfoMeta } from "./index-BM1p0FMj.js";
+export { AccessValidationConfigUpdate, AccessValidationResult, ApiKeyAuthConfig, AuthConfig, AuthErrorResponse, AuthRequestConfig, AuthResponse, BasicAuthConfig, BearerAuthConfig, CountryCode, CountryCodeRestricted, CurrencyCode, CursorPagination, CustomAuthConfig, DebugLevel, Environment, ErrorResponse, HttpMethod, InitOptions, NormalPagination, OAuth2AuthConfig, PageInfoMeta, Response, ResponseStatus, SuccessResponse, UnifiedResponse, UserConfig, UserUrls, ValidationError, ValidationErrorResponse, XGenericObject };

package/dist/find-up-simple-BGJv1vWM.cjs

@@ -0,0 +1,34 @@
+const require_chunk = require('./chunk-BncF-t-1.cjs');
+let node_path = require("node:path");
+node_path = require_chunk.__toESM(node_path);
+let node_process = require("node:process");
+node_process = require_chunk.__toESM(node_process);
+let node_fs_promises = require("node:fs/promises");
+node_fs_promises = require_chunk.__toESM(node_fs_promises);
+let node_url = require("node:url");
+node_url = require_chunk.__toESM(node_url);
+
+//#region ../../node_modules/.pnpm/find-up-simple@1.0.1/node_modules/find-up-simple/index.js
+async function findUp(name, { cwd = node_process.default.cwd(), type = "file", stopAt } = {}) {
+	let directory = node_path.default.resolve(toPath(cwd) ?? "");
+	const { root } = node_path.default.parse(directory);
+	stopAt = node_path.default.resolve(directory, toPath(stopAt ?? root));
+	const isAbsoluteName = node_path.default.isAbsolute(name);
+	while (directory) {
+		const filePath = isAbsoluteName ? name : node_path.default.join(directory, name);
+		try {
+			const stats = await node_fs_promises.default.stat(filePath);
+			if (type === "file" && stats.isFile() || type === "directory" && stats.isDirectory()) return filePath;
+		} catch {}
+		if (directory === stopAt || directory === root) break;
+		directory = node_path.default.dirname(directory);
+	}
+}
+var toPath;
+var init_find_up_simple = require_chunk.__esm({ "../../node_modules/.pnpm/find-up-simple@1.0.1/node_modules/find-up-simple/index.js": (() => {
+	toPath = (urlOrPath) => urlOrPath instanceof URL ? (0, node_url.fileURLToPath)(urlOrPath) : urlOrPath;
+}) });
+
+//#endregion
+init_find_up_simple();
+exports.findUp = findUp;

package/dist/find-up-simple-eHmrWCoZ.js

@@ -0,0 +1,30 @@
+import { n as __esm } from "./chunk-BLWcukCW.js";
+import path from "node:path";
+import process from "node:process";
+import fsPromises from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+
+//#region ../../node_modules/.pnpm/find-up-simple@1.0.1/node_modules/find-up-simple/index.js
+async function findUp(name, { cwd = process.cwd(), type = "file", stopAt } = {}) {
+	let directory = path.resolve(toPath(cwd) ?? "");
+	const { root } = path.parse(directory);
+	stopAt = path.resolve(directory, toPath(stopAt ?? root));
+	const isAbsoluteName = path.isAbsolute(name);
+	while (directory) {
+		const filePath = isAbsoluteName ? name : path.join(directory, name);
+		try {
+			const stats = await fsPromises.stat(filePath);
+			if (type === "file" && stats.isFile() || type === "directory" && stats.isDirectory()) return filePath;
+		} catch {}
+		if (directory === stopAt || directory === root) break;
+		directory = path.dirname(directory);
+	}
+}
+var toPath;
+var init_find_up_simple = __esm({ "../../node_modules/.pnpm/find-up-simple@1.0.1/node_modules/find-up-simple/index.js": (() => {
+	toPath = (urlOrPath) => urlOrPath instanceof URL ? fileURLToPath(urlOrPath) : urlOrPath;
+}) });
+
+//#endregion
+init_find_up_simple();
+export { findUp };

package/dist/{index-DUI9uPJQ.d.ts → index-BA7Ul1Pi.d.cts}

@@ -10,6 +10,7 @@ interface XGenericObject {
 //#endregion
 //#region src/Contracts/Core.d.ts
 type Environment = 'sandbox' | 'live';
+type DebugLevel = 0 | 1 | 2 | 3;
 type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
 type ResponseStatus = 'failed' | 'success';
 interface ValidationError {
@@ -124,11 +125,11 @@ interface InitOptions {
   /**
    * Your API Public Key
    */
-  clientId: string;
+  clientId?: string;
   /**
    * Your API Secret Key
    */
-  clientSecret: string;
+  clientSecret?: string;
   /**
    * Your API Encryption Key
    */
@@ -153,14 +154,11 @@ interface InitOptions {
    * Request authentication strategy or strategies.
    */
   auth?: AuthConfig | AuthConfig[];
+  /**
+   * HTTP debug verbosity. Use 0 to disable logging.
+   */
+  debugLevel?: DebugLevel;
 }
-interface UserConfig {
-  environment?: Environment;
-  urls?: UserUrls;
-  headers?: Record<string, string>;
-  timeout?: number;
-  encryptionKey?: string;
-  auth?: AuthConfig | AuthConfig[];
-}
+interface UserConfig extends InitOptions {}
 //#endregion
-export { CurrencyCode as A, UserConfig as C, XGenericObject as D, ValidationErrorResponse as E, CountryCode as O, UnifiedResponse as S, ValidationError as T, OAuth2AuthConfig as _, AuthErrorResponse as a, ResponseStatus as b, BasicAuthConfig as c, CustomAuthConfig as d, Environment as f, NormalPagination as g, InitOptions as h, AuthConfig as i, CountryCodeRestricted as k, BearerAuthConfig as l, HttpMethod as m, AccessValidationResult as n, AuthRequestConfig as o, ErrorResponse as p, ApiKeyAuthConfig as r, AuthResponse as s, AccessValidationConfigUpdate as t, CursorPagination as u, PageInfoMeta as v, UserUrls as w, SuccessResponse as x, Response as y };
+export { CountryCodeRestricted as A, UnifiedResponse as C, ValidationErrorResponse as D, ValidationError as E, XGenericObject as O, SuccessResponse as S, UserUrls as T, NormalPagination as _, AuthErrorResponse as a, Response as b, BasicAuthConfig as c, CustomAuthConfig as d, DebugLevel as f, InitOptions as g, HttpMethod as h, AuthConfig as i, CurrencyCode as j, CountryCode as k, BearerAuthConfig as l, ErrorResponse as m, AccessValidationResult as n, AuthRequestConfig as o, Environment as p, ApiKeyAuthConfig as r, AuthResponse as s, AccessValidationConfigUpdate as t, CursorPagination as u, OAuth2AuthConfig as v, UserConfig as w, ResponseStatus as x, PageInfoMeta as y };

package/dist/{index-JjhthUpt.d.cts → index-BM1p0FMj.d.ts}

@@ -10,6 +10,7 @@ interface XGenericObject {
 //#endregion
 //#region src/Contracts/Core.d.ts
 type Environment = 'sandbox' | 'live';
+type DebugLevel = 0 | 1 | 2 | 3;
 type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
 type ResponseStatus = 'failed' | 'success';
 interface ValidationError {
@@ -124,11 +125,11 @@ interface InitOptions {
   /**
    * Your API Public Key
    */
-  clientId: string;
+  clientId?: string;
   /**
    * Your API Secret Key
    */
-  clientSecret: string;
+  clientSecret?: string;
   /**
    * Your API Encryption Key
    */
@@ -153,14 +154,11 @@ interface InitOptions {
    * Request authentication strategy or strategies.
    */
   auth?: AuthConfig | AuthConfig[];
+  /**
+   * HTTP debug verbosity. Use 0 to disable logging.
+   */
+  debugLevel?: DebugLevel;
 }
-interface UserConfig {
-  environment?: Environment;
-  urls?: UserUrls;
-  headers?: Record<string, string>;
-  timeout?: number;
-  encryptionKey?: string;
-  auth?: AuthConfig | AuthConfig[];
-}
+interface UserConfig extends InitOptions {}
 //#endregion
-export { CurrencyCode as A, UserConfig as C, XGenericObject as D, ValidationErrorResponse as E, CountryCode as O, UnifiedResponse as S, ValidationError as T, OAuth2AuthConfig as _, AuthErrorResponse as a, ResponseStatus as b, BasicAuthConfig as c, CustomAuthConfig as d, Environment as f, NormalPagination as g, InitOptions as h, AuthConfig as i, CountryCodeRestricted as k, BearerAuthConfig as l, HttpMethod as m, AccessValidationResult as n, AuthRequestConfig as o, ErrorResponse as p, ApiKeyAuthConfig as r, AuthResponse as s, AccessValidationConfigUpdate as t, CursorPagination as u, PageInfoMeta as v, UserUrls as w, SuccessResponse as x, Response as y };
+export { CountryCodeRestricted as A, UnifiedResponse as C, ValidationErrorResponse as D, ValidationError as E, XGenericObject as O, SuccessResponse as S, UserUrls as T, NormalPagination as _, AuthErrorResponse as a, Response as b, BasicAuthConfig as c, CustomAuthConfig as d, DebugLevel as f, InitOptions as g, HttpMethod as h, AuthConfig as i, CurrencyCode as j, CountryCode as k, BearerAuthConfig as l, ErrorResponse as m, AccessValidationResult as n, AuthRequestConfig as o, Environment as p, ApiKeyAuthConfig as r, AuthResponse as s, AccessValidationConfigUpdate as t, CursorPagination as u, OAuth2AuthConfig as v, UserConfig as w, ResponseStatus as x, PageInfoMeta as y };