splunk · vmalaviya-splunk · Mar 9, 2022 · Mar 31, 2020 · Jun 30, 2020 · Jul 4, 2020
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,7 +5,7 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ${{ matrix.os }}
-    
+
     strategy:
       matrix:
         os:
@@ -15,29 +15,29 @@ jobs:
           - 8.17.0
         splunk-version:
           - "8.0"
-          - "latest" 
-          
+          - "latest"
+
     services:
       splunk:
         image: splunk/splunk:${{matrix.splunk-version}}
         env:
           SPLUNK_START_ARGS: --accept-license
           SPLUNK_HEC_TOKEN: 11111111-1111-1111-1111-1111111111113
           SPLUNK_PASSWORD: changed!
-          SPLUNK_APPS_URL: https://github.com/splunk/sdk-app-collection/releases/download/v1.0.0/sdk-app-collection.tgz
+          SPLUNK_APPS_URL: https://github.com/splunk/sdk-app-collection/releases/download/v1.1.0/sdkappcollection.tgz
         ports:
           - 8000:8000
           - 8088:8088
           - 8089:8089
-          
+
     steps:
       - uses: actions/checkout@v2
-      
+
       - name: Use node ${{ matrix.node }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
-          
+
       - name: Create .splunkrc file
         run: |
           cd ~
@@ -47,10 +47,10 @@ jobs:
           echo password=changed! >> .splunkrc
           echo scheme=https >> .splunkrc
           echo version=${{ matrix.splunk }} >> .splunkrc
-        
+
       - name: Run npm install
-        run: npm install  
-        
+        run: npm install
+
       - name: Run make test
         run: make test
         env:

diff --git a/.jshintignore b/.jshintignore
@@ -5,8 +5,10 @@ node_modules
 build
 client
 external
+examples/browser/create-react-app
 examples/browser/minisplunk
 examples/browser/resources
+examples\\browser\\create-react-app
 examples\\browser\\minisplunk
 examples\\browser\\resources
 old_english

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,22 @@
 # Splunk Enterprise SDK for JavaScript Changelog
 
+## v1.11.0
+
+### Major changes
+* DVPL-9708 apps/local support ([PR#135](https://github.com/splunk/splunk-sdk-javascript/pull/135))
+* .conf CRUD functionality added ([PR#141](https://github.com/splunk/splunk-sdk-javascript/pull/141))
+### Minor changes
+* NodeUnit to Mocha Transition for Browser Test Cases ([PR#127](https://github.com/splunk/splunk-sdk-javascript/pull/127))
+* Login example and README.md change ([PR#138](https://github.com/splunk/splunk-sdk-javascript/pull/138))
+* Add pagination support to history calls ([PR#95](https://github.com/splunk/splunk-sdk-javascript/pull/95))
+* Changes for savedsearch history pagination ([PR#139](https://github.com/splunk/splunk-sdk-javascript/pull/139))
+* Add create-react-app browser example ([PR#99](https://github.com/splunk/splunk-sdk-javascript/pull/99))
+* Support added for output_mode for oneShotSearch ([PR#140](https://github.com/splunk/splunk-sdk-javascript/pull/140))
+* Updated Highcharts License. ([PR#119](https://github.com/splunk/splunk-sdk-javascript/pull/119))
+* package-lock.json updated ([PR#137](https://github.com/splunk/splunk-sdk-javascript/pull/137))
+* WIP: Stabilize CI/CD ([PR#115](https://github.com/splunk/splunk-sdk-javascript/pull/115))
+* Dependency updates ([PR#145](https://github.com/splunk/splunk-sdk-javascript/pull/145))
+
 ## v1.10.0
 
 ### Major changes

diff --git a/CREDITS.md b/CREDITS.md
@@ -17,4 +17,5 @@ Some of the components included in the Splunk Enterprise SDK for JavaScript are
 | [dotenv](https://github.com/motdotla/dotenv) | Loads environment varibles from .env file | [BSD 2-Clause](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-DOTENV) |
 | [cookie](https://github.com/jshttp/cookie) | HTTP cookie parser and serializer for HTTP servers | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-COOKIE) |
 | [elementtree](https://github.com/racker/node-elementtree) | Node.js XML parserer and serializer | [Apache-2.0](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-ELEMENTTREE) |
-| [needle](https://github.com/tomas/needle) | Node.js http client | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-NEEDLE) |
+| [needle](https://github.com/tomas/needle) | Node.js http client | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-NEEDLE) |
+| [Highcharts](https://github.com/highcharts/highcharts) | Interactive JavaScript charts | 
diff --git a/README.md b/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.10.0
+#### Version 1.11.0
 
 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.
 
@@ -89,6 +89,8 @@ This HTML example uses the Splunk Enterprise SDK for JavaScript to list all jobs
 
 This example shows how to use the Splunk Enterprise SDK for JavaScript and Node.js to list all jobs:
 
+##### Login with username and password
+
 ```javascript
     var splunkjs = require('splunk-sdk');
 
@@ -107,6 +109,73 @@ This example shows how to use the Splunk Enterprise SDK for JavaScript and Node.
         });
     });
 ```
+##### Login with sessionKey
+
+```shell
+# Create a sessionKey
+curl -k -u <username>:<password>  <scheme>://<host>:<port>/services/auth/login -d username=<username> -d password=<password>
+```
+
+```javascript
+var serviceWithSessionKey = new splunkjs.Service(
+    {
+        // Replace the host if you are accessing remote host
+        scheme: 'https',
+        host: 'localhost',
+        port: '8089',
+        sessionKey: SESSION_KEY, // Add your sessionKey here
+        version: '8',
+    });
+
+serviceWithSessionKey.get("search/jobs", { count: 1 }, function (err, res) {
+    if (err) {
+        console.log(err);
+    } else }
+        console.log("Login successful with sessionKey");
+    }
+});
+```
+
+##### Login with token
+
+```shell
+#### From shell ####
+# Enable token authetication
+curl -k -u <username>:<password> -X POST <scheme>://<host>:<port>/services/admin/token-auth/tokens_auth -d disabled=false
+
+# Create a token
+curl -k -u <username>:<password> -X POST <scheme>://<host>:<port>/services/authorization/tokens?output_mode=json --data name=<username> --data audience=Users --data-urlencode expires_on=+30d
+```
+
+```shell
+#### From web ####
+# Enable token authentication
+Go to settings > Tokens and click on 'Enable Token Authentication'
+
+# Create a token
+1. Go to settings > Token and click on 'New Token'
+2. Enter the relevant information
+3. Copy the created token and save it somewhere safe.
+```
+
+```javascript
+var serviceWithBearerToken = new splunkjs.Service(
+    {
+        // Replace the host if you are accessing remote host
+        scheme: 'https',
+        host: 'localhost',
+        port: '8089',
+        sessionKey: TOKEN, // Add your token here
+        version: '8',
+    });
+
+serviceWithBearerToken.get("search/jobs", { count: 2 }, function (err, res) {
+    if (err)
+        console.log(err);
+    else
+        console.log("Login successful with bearer token");
+});
+```
 
 ## SDK examples
 
@@ -150,6 +219,32 @@ Save the file as **.splunkrc** in the current user's home directory.
 
     Click **Yes**, then continue creating the file.
 
+### Create/Update a .conf file
+```javascript
+
+Async.chain([
+    function (done) {
+        // Fetch configurations
+        var configs = svc.configurations(namespace);
+        configs.fetch(done);
+    },
+    async function (configs, done) {
+        // Create a key-value map to store under a stanza
+        const filename = "app.conf";
+        const stanzaName = "install";
+        var keyValueMap = {}
+        keyValueMap["state"] = "enabled";
+        keyValueMap["python.version"] = "python3";
+
+        // If file/stanza doesn't exist, it will be created 
+        // else it will be updated.
+        configs.createAsync(filename, stanzaName, keyValueMap, done);
+    }
+],
+function (err) {
+    done();
+});
+```
 
 ### Client-side examples
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -8,7 +8,7 @@ services:
             - SPLUNK_START_ARGS=--accept-license
             - SPLUNK_HEC_TOKEN=11111111-1111-1111-1111-1111111111113
             - SPLUNK_PASSWORD=changed!
-            - SPLUNK_APPS_URL=https://github.com/splunk/sdk-app-collection/releases/download/v1.0.0/sdk-app-collection.tgz
+            - SPLUNK_APPS_URL=https://github.com/splunk/sdk-app-collection/releases/download/v1.1.0/sdkappcollection.tgz
         ports:
             - 8000:8000
             - 8088:8088

diff --git a/examples/browser/create-splunk-react-app/.gitignore b/examples/browser/create-splunk-react-app/.gitignore
@@ -0,0 +1,25 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+package-lock.json
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/examples/browser/create-splunk-react-app/README.md b/examples/browser/create-splunk-react-app/README.md
@@ -0,0 +1,74 @@
+# create-splunk-react-app
+
+Enter this directory and run `yarn start` to view the app:
+
+![create-splunk-react-app demo](create-splunk-react-app.gif)
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.<br />
+Open [https://localhost:3000](https://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `yarn build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
diff --git a/examples/browser/create-splunk-react-app/create-splunk-react-app.gif b/examples/browser/create-splunk-react-app/create-splunk-react-app.gif
diff --git a/examples/browser/create-splunk-react-app/package.json b/examples/browser/create-splunk-react-app/package.json
@@ -0,0 +1,38 @@
+{
+  "name": "splunk-create-react-app",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "assert": "^2.0.0",
+    "jquery": "^3.6.0",
+    "nodeunit": "^0.11.3",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-scripts": "3.4.1",
+    "splunk-sdk": "^1.10.0"
+  },
+  "scripts": {
+    "start": "HTTPS=true react-scripts start --no-cache",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
diff --git a/examples/browser/create-splunk-react-app/public/favicon.ico b/examples/browser/create-splunk-react-app/public/favicon.ico