Release/1.12.1

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Generate docs
         run: |
           node sdkdo docs
-          zip -r docs.zip docs/${{ steps.pkgjson.outputs.packageVersion }}/refs
+          zip -r docs.zip docs-${{ steps.pkgjson.outputs.packageVersion }}
 
       - name: Upload Artifact
         uses: actions/upload-artifact@v3

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Splunk Enterprise SDK for JavaScript Changelog
 
+## v1.12.1
+
+### Minor changes
+* Special handling related to the semantic versioning of specific Search APIs functional in Splunk Enterprise 9.0.2 and (Splunk Cloud 9.0.2209). These SDK changes will enable seamless transition between the APIs based on the version of the Splunk Enterprise in use ([PR#163](https://github.com/splunk/splunk-sdk-javascript/pull/163))
+* added checks for wildcards in StoragePasswords ([PR#156](https://github.com/splunk/splunk-sdk-javascript/pull/156))
+* Update release docs path in release.yml ([PR#161](https://github.com/splunk/splunk-sdk-javascript/pull/161))
+
 ## v1.12.0
 
 ### New features and APIs

README.md

@@ -1,7 +1,7 @@
 [![Build Status](https://travis-ci.org/splunk/splunk-sdk-javascript.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-javascript)
 # The Splunk Enterprise Software Development Kit for JavaScript
 
-#### Version 1.12.0
+#### Version 1.12.1
 
 The Splunk Enterprise Software Development Kit (SDK) for JavaScript contains library code and examples designed to enable developers to build applications using the Splunk platform and JavaScript. This SDK supports server-side and client-side JavaScript.
 

client/splunk.js

@@ -683,6 +683,7 @@ var __exportName = 'splunkjs';
             this.version       = params.version || "default";
             this.timeout       = params.timeout || 0;
             this.autologin     = true;
+            this.instanceType  = "";
 
             // Initialize autologin
             // The reason we explicitly check to see if 'autologin'
@@ -717,16 +718,17 @@ var __exportName = 'splunkjs';
 
             // We perform the bindings so that every function works
             // properly when it is passed as a callback.
-            this._headers         = utils.bind(this, this._headers);
-            this.fullpath         = utils.bind(this, this.fullpath);
-            this.urlify           = utils.bind(this, this.urlify);
-            this.get              = utils.bind(this, this.get);
-            this.del              = utils.bind(this, this.del);
-            this.post             = utils.bind(this, this.post);
-            this.login            = utils.bind(this, this.login);
-            this._shouldAutoLogin = utils.bind(this, this._shouldAutoLogin);
-            this._requestWrapper  = utils.bind(this, this._requestWrapper);
-            this.getVersion       = utils.bind(this, this.getVersion);
+            this._headers           = utils.bind(this, this._headers);
+            this.fullpath           = utils.bind(this, this.fullpath);
+            this.urlify             = utils.bind(this, this.urlify);
+            this.get                = utils.bind(this, this.get);
+            this.del                = utils.bind(this, this.del);
+            this.post               = utils.bind(this, this.post);
+            this.login              = utils.bind(this, this.login);
+            this._shouldAutoLogin   = utils.bind(this, this._shouldAutoLogin);
+            this._requestWrapper    = utils.bind(this, this._requestWrapper);
+            this.getInfo            = utils.bind(this, this.getInfo);
+            this.disableV2SearchApi = utils.bind(this, this.disableV2SearchApi);
         },
 
         /**
@@ -897,19 +899,21 @@ var __exportName = 'splunkjs';
          * @method splunkjs.Context
          * @private
          */
-        getVersion: function (callback) {
+        getInfo: function (callback) {
             var that = this;
             var url = this.paths.info;
 
             callback = callback || function() {};
 
             var wrappedCallback = function(err, response) {
                 var hasVersion = !!(!err && response.data && response.data.generator.version);
+                let hasInstanceType = !!(!err && response.data && response.data.generator["instance_type"]);
 
                 if (err || !hasVersion) {
                     callback(err || "No version found", false);
                 }
                 else {
+                    that.instanceType = hasInstanceType ? response.data.generator["instance_type"] : "";
                     that.version = response.data.generator.version;
                     that.http.version = that.version;
                     callback(null, true);
@@ -954,7 +958,7 @@ var __exportName = 'splunkjs';
                 }
                 else {
                     that.sessionKey = response.data.sessionKey;
-                    that.getVersion(callback);
+                    that.getInfo(callback);
                 }
             };
             return this.http.post(
@@ -1131,6 +1135,16 @@ var __exportName = 'splunkjs';
                 }
             }
             return 0;
+        },
+
+        disableV2SearchApi: function(){
+            let val;
+            if(this.instanceType.toLowerCase() == "cloud"){
+                val = this.versionCompare("9.0.2209");
+            }else{
+                val = this.versionCompare("9.0.2")
+            }
+            return val < 0;
         }
     });
 
@@ -2910,7 +2924,7 @@ var __exportName = 'splunkjs';
             params.q = query;
 
             // Pre-9.0 uses GET and v1 endpoint
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 return this.get(Paths.parser, params, function(err, response) {
                     if (err) {
                         callback(err);
@@ -4433,6 +4447,12 @@ var __exportName = 'splunkjs';
          */     
         init: function(service, namespace) {
             this._super(service, this.path(), namespace);
+        },
+        create: function(params, callback){
+            if(this.service.app == '-' || this.service.owner == '-'){
+                throw new Error("While creating StoragePasswords, namespace cannot have wildcards.");
+            }
+            this._super(params,callback);
         }
     });
 
@@ -5688,7 +5708,7 @@ var __exportName = 'splunkjs';
          */
         path: function () {
             // Pre-9.0 uses v1 endpoint
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 return Paths.jobs + "/" + encodeURIComponent(this.name);
             }
             // Post-9.0 uses v2 endpoint
@@ -5713,6 +5733,7 @@ var __exportName = 'splunkjs';
             // Passing the service version and versionCompare to this.path() before instantiating splunkjs.Service.Entity.
             this.version = service.version;
             this.versionCompare = service.versionCompare;
+            this.disableV2SearchApi = service.disableV2SearchApi;
 
             this.name = sid;
             this._super(service, this.path(), namespace);
@@ -5837,7 +5858,7 @@ var __exportName = 'splunkjs';
             var eventsPath = Paths.jobsV2 + "/" + encodeURIComponent(this.name) + "/events";
             // Splunk version pre-9.0 doesn't support v2
             // v1(GET), v2(POST)
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 eventsPath = Paths.jobs + "/" + encodeURIComponent(this.name) + "/events";
                 return this.get(eventsPath, params, function(err, response) {
                     if (err) {
@@ -5953,7 +5974,7 @@ var __exportName = 'splunkjs';
             var resultsPreviewPath = Paths.jobsV2 + "/" + encodeURIComponent(this.name) + "/results_preview";
             // Splunk version pre-9.0 doesn't support v2
             // v1(GET), v2(POST)
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 resultsPreviewPath = Paths.jobs + "/" + encodeURIComponent(this.name) + "/results_preview";
                 return this.get(resultsPreviewPath, params, function(err, response) {
                     if (err) {
@@ -6006,7 +6027,7 @@ var __exportName = 'splunkjs';
             var resultsPath = Paths.jobsV2 + "/" + encodeURIComponent(this.name) + "/results";
             // Splunk version pre-9.0 doesn't support v2
             // v1(GET), v2(POST)
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 resultsPath = Paths.jobs + "/" + encodeURIComponent(this.name) + "/results";
                 return this.get(resultsPath, params, function(err, response) {
                     if (err) {
@@ -6347,7 +6368,7 @@ var __exportName = 'splunkjs';
          */
         path: function () {
             // Pre-9.0 uses v1 endpoint
-            if (this.versionCompare("9.0") < 0) {
+            if (this.disableV2SearchApi()) {
                 return Paths.jobs;
             }
             // Post-9.0 uses v2 endpoint
@@ -6385,6 +6406,7 @@ var __exportName = 'splunkjs';
             // Passing the service version and versionCompare to this.path() before instantiating splunkjs.Service.Collection.
             this.version = service.version;
             this.versionCompare = service.versionCompare;
+            this.disableV2SearchApi = service.disableV2SearchApi;
 
             this._super(service, this.path(), namespace);
             // We perform the bindings so that every function works 
@@ -29945,7 +29967,7 @@ module.exports={
   "_args": [
     [
       "elliptic@6.5.4",
-      "/Users/tpavlik/src/enterprise/semantic-versioning/splunk-sdk-javascript"
+      "/Users/abhis/Documents/JS/splunk-sdk-javascript"
     ]
   ],
   "_development": true,
@@ -29971,7 +29993,7 @@ module.exports={
   ],
   "_resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.4.tgz",
   "_spec": "6.5.4",
-  "_where": "/Users/tpavlik/src/enterprise/semantic-versioning/splunk-sdk-javascript",
+  "_where": "/Users/abhis/Documents/JS/splunk-sdk-javascript",
   "author": {
     "name": "Fedor Indutny",
     "email": "fedor@indutny.com"
@@ -39855,7 +39877,7 @@ module.exports={
   "_args": [
     [
       "needle@3.0.0",
-      "/Users/tpavlik/src/enterprise/semantic-versioning/splunk-sdk-javascript"
+      "/Users/abhis/Documents/JS/splunk-sdk-javascript"
     ]
   ],
   "_from": "needle@3.0.0",
@@ -39879,13 +39901,13 @@ module.exports={
   ],
   "_resolved": "https://registry.npmjs.org/needle/-/needle-3.0.0.tgz",
   "_spec": "3.0.0",
-  "_where": "/Users/tpavlik/src/enterprise/semantic-versioning/splunk-sdk-javascript",
+  "_where": "/Users/abhis/Documents/JS/splunk-sdk-javascript",
   "author": {
     "name": "Tomás Pollak",
     "email": "tomas@forkhq.com"
   },
   "bin": {
-    "needle": "bin/needle"
+    "needle": "./bin/needle"
   },
   "bugs": {
     "url": "https://github.com/tomas/needle/issues"
@@ -55692,7 +55714,7 @@ function extend() {
 },{}],259:[function(require,module,exports){
 module.exports={
     "name": "splunk-sdk",
-    "version": "1.11.0",
+    "version": "1.12.1",
     "description": "SDK for usage with the Splunk REST API",
     "homepage": "http://dev.splunk.com",
     "main": "index.js",