A powerful toolkit for streamlining Oracle CPQ Cloud development workflows.

• Seamless code loading/unloading for BML, XSL, JSON, XML, and CSS files
• Support for Commerce Actions, Rules, and Configuration rules
• Document Designer integration
• Header & Footer management
• Interface (SOAP/REST) handling
• Advanced stylesheet operations with minification and browser compatibility checks
• Test script support
• Built-in validation tools

• Google Chrome Browser

• Codium OR Visual Studio Code

https://marketplace.visualstudio.com/items?itemName=CPQConsultant.cpq-devkit-overview

1. Download the latest version of Streamline Tools here.

2. Extract the files into their own directory.

3. Click the Chrome menu icon and select Extensions from the More Tools menu.

4. Enable Developer Mode in the upper right-hand corner.

5. Press the "Load unpacked" button.

6. Select the folder with the extracted files.

7. Open your local "Downloads" folder in Visual Studio Code.

8. Install the latest version of "CPQ DevKit" Extension for VSCode found here, or by running:

   code --install-extension CPQConsultant.cpq-devkit-o

9. Congratulations you've successfully installed Streamline Tools!

Coming soon...

1. Clone the repository:

   git clone https://github.com/loganbek/streamline-tools.git
   cd streamline-tools

2. Install dependencies:

   npm install

3. Create a .env file with required credentials:

   CPQ_USERNAME=your_username
   CPQ_PASSWORD=your_password
   BASE_URL=your_cpq_instance_url
   

This project follows the StandardJS style guide. To ensure code quality:

1. Use the built-in linting:

   npm run lint

2. Fix common style issues:

   npm run lint:fix

Before running tests, ensure you have completed the following setup:

1. Create a .env file in the tests directory with the following variables:

   CPQ_USERNAME=your_username
   CPQ_PASSWORD=your_password
   BASE_URL=your_cpq_instance_url  # e.g., https://yourinstance.bigmachines.com
   

2. Install dependencies:

   npm install

We've streamlined the testing approach to focus directly on the 16 rule types defined in src/rulesList.json, ensuring comprehensive coverage of all Oracle CPQ Cloud application areas.

• Quick Testing - Run one test from each application area:

  npm run test:cpq-sample

• Full Testing - Run all tests for the 16 rule types:

  npm run test:cpq-all

• Default Option - Same as full testing:

  npm run test:cpq

• Run all tests:

  npm test

• Run specific test suites:

  npm run test:unit        # Run unit tests only
  npm run test:puppeteer   # Run Puppeteer integration tests
  npm run test:config      # Test configuration rules
  npm run test:commerce    # Test commerce rules
  npm run test:interfaces  # Test interfaces
  npm run test:stylesheets # Test stylesheets
  npm run test:documents   # Test document designer
  npm run test:utils       # Test utility functions

• Run tests in watch mode (useful during development):

  npm run test:watch

The test suite is organized as follows:

• tests/puppeteer/rulesList-master.test.js - Tests all 16 rule types from rulesList.json
• tests/puppeteer/rulesList-sample.test.js - Tests one rule from each app area
• tests/unit/ - Unit tests for individual components
• tests/__mocks__/ - Mock implementations for testing

If you need to organize your test files or clean up unnecessary tests, use the provided script:

# Move unnecessary test files to archive folder
node organize-tests.js

# Preview what files would be moved without actually moving them
node organize-tests.js --dry-run

# Restore archived test files
node organize-tests.js --restore

If tests fail, you can:

1. Check the screenshots captured during test execution
2. Review video recordings in the test-videos/ directory
3. Use the --verbose flag for detailed output:

   node run-cpq-tests.js --all --verbose

• Cmd/Ctrl + Shift + 1 - Show Streamline Tools UI
• Cmd/Ctrl+Left - Unload Code (BML/XSL/JSON/XML/CSS)
• Cmd/Ctrl+Right - Load Code (BML/XSL/JSON/XML/CSS)

1. Open chrome://extensions/shortcuts in your browser.
2. Locate Streamline Tools and assign custom key combinations for each action.
3. Ensure combinations include "Ctrl" or "Ctrl + Shift" (or "Cmd" on macOS) with any available key.
4. Remove shortcuts by clicking the “X” next to the assigned key combination.

• Cmd/Ctrl + Shift + 1 - Show Streamline Tools UI
• Ctrl+Left - Unload Code (BML/XSL/JSON/XML/CSS)
• Ctrl+Right - Load Code (BML/XSL/JSON/XML/CSS)

1. To customize Streamline Tools' keyboard shortcuts, navigate to chrome://extensions/shortcuts.

2. Scroll to Streamline Tools and for each action choose a combination of keys with either “Ctrl” or “Ctrl + Shift” and any available key. This will automatically work for "Cmd" in place of "Ctrl" on Mac OS.

3. To remove action shortcuts, just click “X” next to the key combination you wish to get rid of.

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (npm test)
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Please ensure your PR:

• Follows the StandardJS style guide
• Includes appropriate tests
• Updates documentation as needed
• Follows the existing code structure

For vulnerability reports or security concerns, please email logan@bekconsulting.info

1. Hard Refresh/Clear Cache

   • Ctrl + Shift + R (Windows)
   • Cmd + Shift + R (Mac)

2. Remove the extension and then reinstall it after filing a bug report here. Please include any error logs from the console.

• CPQ DevKit: A comprehensive toolkit for CPQ development
• CPQ Tools: Additional tools for CPQ development
• CPQ Samples: Sample projects and code snippets

This project is licensed under the Unlicense - see the UNLICENSE file for details.