BillingPlatform Dev Helper

BillingPlatform Widget Tools Manage your BillingPlatform Extension Widgets directly from within Visual Studio Code. This extension provides a seamless workflow to download, edit, and deploy widget code (JavaScript, SCSS, HTML) without leaving your editor.

This tool is designed to significantly speed up the development lifecycle for BillingPlatform developers by bringing standard source control and powerful editing capabilities to your widget code.

Features Secure Authentication: Securely log in to your BillingPlatform instance by providing your base URL, username, and password. Your credentials are never stored in plain text.

Download All Widgets: Run a command to fetch a list of all available Extension Widgets from your instance, select the ones you need from a dropdown menu, and download them into organized folders within your workspace.

Download by ID: Quickly pull a specific widget into your workspace by providing its unique ID.

Deploy on Save: Push your local changes to JavaScript, SCSS, or HTML files back to the BillingPlatform server with a single command.

Getting Started Follow these steps to get up and running:

1. Login to Your Instance Before you can do anything, you must authenticate with your BillingPlatform instance.

Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).

Run the command BillingPlatform: Login.

You will be prompted to enter your Base URL first (e.g., https://mycompany.billingplatform.com/prod). This is saved for future sessions.

Next, enter your username and password.

A success message will appear upon a successful login.

2. Download Widget Code You have two options for getting code into your local workspace.

Option A: Download from a List

Run the command BillingPlatform: Download Widgets to Workspace.

Select the widgets you wish to download from the multi-select list.

Folders named after each widget's Token will be created in your workspace, containing index.js, index.scss, and index.html.

Option B: Download a Single Widget by ID

Run the command BillingPlatform: Download Widget by ID.

Enter the ID of the widget you want to download.

A folder for that widget will be created in your workspace.

3. Edit and Deploy Open any of the downloaded files (index.js, index.scss, or index.html).

Make your code changes and save the file.

With the file still open, run the command BillingPlatform: Deploy Active File.

Your changes will be instantly uploaded and deployed to the server.

Extension Settings This extension contributes the following setting, which can be configured in your User or Workspace settings.json file:

billingplatform.apiUrl: Stores the base URL for your BillingPlatform instance. It's recommended to set this once via the Login command.

Known Issues File association is not permanent. The link between a local file and its server-side widget is stored in memory for the current VS Code session. If you close and reopen VS Code, you must run one of the download commands again to re-establish this link before you can deploy a file.

Release Notes 1.0.0 Initial release of the BillingPlatform Widget Tools.

Added core functionality for Login, Download, and Deploy commands.

Enjoy!