@adobe/spacecat-shared-splunk-client 1.0.29 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [@adobe/spacecat-shared-splunk-client-v1.1.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-splunk-client-v1.0.30...@adobe/spacecat-shared-splunk-client-v1.1.0) (2026-02-27)
+
+### Features
+
+* add slack for redirects ([#1365](https://github.com/adobe/spacecat-shared/issues/1365)) ([7b8176e](https://github.com/adobe/spacecat-shared/commit/7b8176ec7e6788b60da7b76f8924c71f4ef0b26a))
+
+# [@adobe/spacecat-shared-splunk-client-v1.0.30](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-splunk-client-v1.0.29...@adobe/spacecat-shared-splunk-client-v1.0.30) (2026-01-29)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-universal to v5.4.0 ([#1295](https://github.com/adobe/spacecat-shared/issues/1295)) ([5c1595b](https://github.com/adobe/spacecat-shared/commit/5c1595bd7cba9b7053da867b8f46e302f8683eba))
+
 # [@adobe/spacecat-shared-splunk-client-v1.0.29](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-splunk-client-v1.0.28...@adobe/spacecat-shared-splunk-client-v1.0.29) (2025-11-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-splunk-client",
-  "version": "1.0.29",
+  "version": "1.1.0",
   "description": "Shared modules of the Spacecat Services - Splunk Client",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.2.3",
-    "@adobe/helix-universal": "5.3.0",
+    "@adobe/helix-universal": "5.4.0",
     "@adobe/spacecat-shared-utils": "1.81.1",
     "xml-js": "1.6.11"
   },

package/src/index.d.ts

@@ -22,6 +22,14 @@ export interface SplunkAPIOptions {
   mode: string;
   output: string;
 }
+export type SplunkLoginResult =
+  | { sessionId: string; cookie: string }
+  | { error: unknown };
+
+export interface SplunkOneshotResponse {
+  results?: Array<Record<string, unknown>>;
+  [key: string]: unknown;
+}
 
 export default class SplunkAPIClient {
   /**
@@ -45,7 +53,13 @@ export default class SplunkAPIClient {
    * @param password
    */
   login(username?: string, password?: string):
-    Promise<{ result: object }>;
+    Promise<SplunkLoginResult>;
+
+  /**
+   * Execute an ad-hoc Splunk oneshot search.
+   * Throws on error.
+   */
+  oneshotSearch(searchString: string): Promise<SplunkOneshotResponse>;
 
   /**
    * Asynchronous method to check for Not Found errors
@@ -56,5 +70,8 @@ export default class SplunkAPIClient {
    * @param password
    */
   getNotFounds(minutes?: number, username?: string, password?: string):
-    Promise<{ result: object }>;
+    Promise<
+      | { results: Array<Record<string, unknown>> }
+      | { error: unknown }
+    >;
 }

package/src/index.js

@@ -144,4 +144,51 @@ export default class SplunkAPIClient {
 
     return returnObj;
   }
+
+  /**
+   * Execute an ad-hoc Splunk oneshot search and return the JSON payload.
+   *
+   * @param {string} searchString SPL query string (e.g. `search index=... | stats ...`)
+   * @returns {Promise<object>} Splunk oneshot search response JSON
+   */
+  async oneshotSearch(searchString) {
+    if (typeof searchString !== 'string' || searchString.trim().length === 0) {
+      throw new Error('Missing searchString');
+    }
+
+    // Additive behavior: reuse existing login state, otherwise login now.
+    if (!this.loginObj) {
+      this.loginObj = await this.login();
+    }
+    if (this.loginObj?.error) {
+      const err = this.loginObj.error;
+      this.loginObj = null;
+      throw (err instanceof Error ? err : new Error(String(err)));
+    }
+
+    const queryBody = new URLSearchParams({
+      search: searchString,
+      adhoc_search_level: 'fast',
+      exec_mode: 'oneshot',
+      output_mode: 'json',
+    });
+
+    const url = `${this.apiBaseUrl}/servicesNS/admin/search/search/jobs`;
+    const response = await this.fetchAPI(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Splunk ${this.loginObj.sessionId}`,
+        Cookie: this.loginObj.cookie,
+      },
+      body: queryBody,
+    });
+
+    if (response.status !== 200) {
+      const body = await response.text();
+      throw new Error(`Splunk oneshot search failed. Status: ${response.status}. Body: ${body}`);
+    }
+
+    return response.json();
+  }
 }