voxtelesys-flow 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2023, Voxtelesys. <https://voxtelesys.com/>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,186 @@
+# voxtelesys-flow
+
+[![npm version](https://img.shields.io/npm/v/voxtelesys-flow)](https://www.npmjs.com/package/voxtelesys-flow)
+
+## Overview
+
+The [VAST Flow Builder](https://voxtelesys.com/vast-flow) is a low/no-code user interface for building and managing communication flows.
+The `voxtelesys-flow` library allows users to implement the VAST Flow Builder into their own front-end JavaScript applications.
+
+## Getting Started
+
+### Installation
+
+To install this library in your application, run:
+
+```bash
+npm i voxtelesys-flow
+```
+
+### Initialization
+
+To initialize the VAST Flow Builder, create an empty HTML element to mount the Flow Builder into:
+
+```html
+<div id="element-id"/>
+```
+
+Then, mount the Flow Builder using the ID of the HTML element and the available [configuration options](#configuration):
+
+```js
+import { FlowBuilder } from 'voxtelesys-flow'
+
+await FlowBuilder.init('element-id', {
+  apiKey: '<API_KEY>',
+  flowGuid: '<FLOW_GUID>',
+  onBack: history.back,
+  companyName: 'Example Company',
+  companyLogo: 'http://example-company.com/logo',
+  styling: {
+    primaryColor: '#7ac142',
+    leftSidebarWidth: '400px',
+    defaultFontSize: '1rem'
+  }
+})
+```
+
+The default CSS styling for the VAST Flow Builder is bundled with the JavaScript and will be automatically loaded when the library is imported.
+
+### Configuration
+
+#### Parameters
+
+- `apiKey`
+
+  Required. An API key can be created or retrieved from the [API Keys](https://portal.voxtelesys.net/api-keys) page on the Customer Portal.
+
+- `flowGuid`
+
+  Required. The GUID of the Flow that the user will be able to view and edit in the Flow Builder once it has been mounted. To view the Flows that belong to your account,
+  visit the [Flows](https://portal.voxtelesys.net/flow) page on the Customer Portal. Alternatively, you can retrieve a list of Flows using the `GET /flows` route on the Dashboard API, or create a new
+  Flow using the `POST /flows` route.
+
+- `onBack`
+
+  Optional. A function that is executed when the back arrow in the Flow Builder is clicked. If `onBack` is omitted, then the back arrow will be hidden.
+
+- `companyName`
+
+  Optional. The text to be displayed at the bottom of the Flow Builder canvas next to "Powered by Voxtelesys". The `companyName` parameter is used to co-brand the VAST Flow Builder by displaying your
+  company's name on the screen.
+
+- `companyLogo`
+
+  Optional. The path or URL of an image to be displayed at the bottom of the Flow Builder canvas next to "Powered by Voxtelesys". The `companyLogo` parameter is used to co-brand the VAST Flow Builder by displaying your
+  company's logo on the screen.
+
+- `styling`
+
+  Optional. An object with properties that override CSS styles in the Flow Builder.
+
+  The `styling` object can be used to customize the look and feel of the Flow Builder, such as its colors and font sizes. The properties available in `styling` are listed [below](#styling-overrides).
+
+#### Styling Overrides
+
+##### Sizing
+- leftSidebarWidth
+- rightSidebarWidth
+- backgroundOutlineWidth
+
+##### Font
+- fontFamily
+- titleFontSize
+- headingFontSize
+- subheadingFontSize
+- defaultFontSize
+- smallFontSize
+- extraSmallFontSize
+- companyFontSize
+- transitionTime
+
+##### Base Colors
+- whiteColor
+- gray1Color
+- gray2Color
+- gray3Color
+- gray4Color
+- gray5Color
+- gray6Color
+- gray7Color
+- gray8Color
+- gray9Color
+- gray10Color
+- primaryColor
+- secondaryColor
+- tertiaryColor
+- quaternaryColor
+- focusColor
+- deleteColor
+- errorColor
+- warningColor
+- validColor
+- successColor
+- codeColor
+
+##### Alert Colors
+- errorAlertTextColor
+- errorAlertHighlightColor
+- errorAlertBackgroundColor
+- errorAlertShadowColor
+- infoAlertTextColor
+- infoAlertHighlightColor
+- infoAlertBackgroundColor
+- warningAlertTextColor
+- warningAlertHighlightColor
+- warningAlertBackgroundColor
+- successAlertTextColor
+- successAlertHighlightColor
+- successAlertBackgroundColor
+- successAlertBorderColor
+
+##### Hover Colors
+- primaryHoverColor
+- secondaryHoverColor
+- tertiaryHoverColor
+- quaternaryHoverColor
+- deleteHoverColor
+- grayHoverColor
+
+##### Highlight Colors
+- primaryHighlightColor
+- tertiaryHighlightColor
+- grayHighlightColor
+
+##### Background Colors
+- primaryBackgroundColor
+- secondaryBackgroundColor
+- tertiaryBackgroundColor
+- quaternaryBackgroundColor
+- errorBackgroundColor
+- primaryBackgroundHoverColor
+- secondaryBackgroundHoverColor
+- tertiaryBackgroundHoverColor
+- quaternaryBackgroundHoverColor
+
+##### Shadow Colors
+- successShadowColor
+- gray7ShadowColor
+- validShadowColor
+- focusShadowColor
+
+## Dashboard API
+
+All HTTP requests from the VAST Flow Builder are directed to publicly-available routes on the Dashboard API using the API key provided.
+
+In addition to the routes used directly by the VAST Flow Builder, the Dashboard API also provides the ability to:
+- View and manage Flows and Flow Versions
+- View and update telephone numbers (TNs)
+- View and manage route profiles and route profile routes
+- View and manage Voice API profiles
+- Get trunk groups
+
+See the Dashboard API [documentation](https://dashboardapi.voxtelesys.com/) for more details on the available routes.
+
+## Additional Resources
+
+- [Flow Builder Tutorials](https://voxtelesys.com/learning-hub/tutorials?category=vast-flow-builder)

package/dist/index.js

@@ -0,0 +1,26 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+let module;
+export class FlowBuilder {
+    /**
+     * Initializes the VAST Flow Builder SDK.
+     *
+     * @param elementId - The ID of the HTML element to render the Flow Builder in (required).
+     * @param options.apiToken - The API token for authentication (required).
+     */
+    static init(elementId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // @ts-ignore
+            if (!module)
+                module = yield import('https://dmfmrckmde2ek.cloudfront.net/vast-flow-builder-v3.0.2.js');
+            yield module.init(elementId, options);
+        });
+    }
+}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "voxtelesys-flow",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "install": "[ ! -d \"./dist\" ] && npm run build || true",
+    "postversion": "git push && git push --tags"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Voxtelesys",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  }
+}