axway-flow-sdk
Advanced tools
axway-flow-sdk - npm Package Compare versions
Comparing version 3.2.0 to 3.3.0
| { | ||
| "name": "axway-flow-sdk", | ||
| "version": "3.2.0", | ||
| "version": "3.3.0", | ||
| "description": "SDK for implementing custom flow nodes for API Builder flows", | ||
@@ -42,3 +42,2 @@ "homepage": "https://platform.axway.com", | ||
| "@axway/flow": "^6.0.0", | ||
| "node-readme": "^0.1.9", | ||
| "rimraf": "2.6.3" | ||
@@ -52,11 +51,11 @@ }, | ||
| "per-file": false, | ||
| "statements": 95.59, | ||
| "statements": 95.63, | ||
| "branches": 88.32, | ||
| "lines": 95.59 | ||
| "lines": 95.63 | ||
| }, | ||
| "scripts": { | ||
| "build": "npm run build:lint && npm run test", | ||
| "build": "npm run build:lint && npm run test && npm run build:readme", | ||
| "build:lint": "eslint .", | ||
| "build:lint:fix": "eslint . --fix", | ||
| "build:readme": "node-readme && shx mv README.md README.hbs && jsdoc2md --template README.hbs src/index.js > README.md && shx rm -rf README.hbs", | ||
| "build:readme": "jsdoc2md --template .README.md src/index.js > README.md", | ||
| "test": "nyc mocha ./test", | ||
@@ -66,3 +65,3 @@ "test:watch": "npm test -- --watch", | ||
| }, | ||
| "gitHead": "5aa8e8a3c1378beef2e233f8c5358690cdc6afb8" | ||
| "gitHead": "564b6b4339b6b80875837a00d10f9c5a9235d61e" | ||
| } |
@@ -285,6 +285,6 @@ # axway-flow-sdk | ||
| | options.required | <code>boolean</code> | specifies that the parameter is required. Parameters are required by default. | | ||
| | options.multilineWrapper | <code>object</code> | object that holds the before and after parts that surrounds user provided value in the UI. | | ||
| | options.multilineWrapper.before | <code>string</code> | string that is placed before the user provided value in the UI. | | ||
| | options.multilineWrapper.after | <code>string</code> | string that is placed after the user provided value in the UI. | | ||
| | options.initialType | <code>string</code> | autoselects the input type of the field in the ui | | ||
| | options.multilineWrapper | <code>object</code> | describes the before and after parts that surrounds user provided value in the UI. | | ||
| | options.multilineWrapper.before | <code>string</code> | read-only string that is placed before the user provided value in the UI. | | ||
| | options.multilineWrapper.after | <code>string</code> | read-only string that is placed after the user provided value in the UI. | | ||
| | options.initialType | <code>string</code> | The type to display by default in the UI for this parameter. Allowed values are object, array, string, selector, null, boolean and number. | | ||
@@ -406,23 +406,15 @@ **Example** | ||
| ``` | ||
| <a name="module_axway-flow-sdk..getSelectedOptions"></a> | ||
| ### axway-flow-sdk~getSelectedOptions(options) ⇒ <code>object</code> | ||
| Add user provided option to the parameter schema. | ||
| # Changes | ||
| **Kind**: inner method of [<code>axway-flow-sdk</code>](#module_axway-flow-sdk) | ||
| **Returns**: <code>object</code> - selected options and a flag that is set to true if there are selected options. | ||
| #### 3.3.0 | ||
| - #5892: Added support for defining a type for parameters to display by default in the Flow editor. Previously parameters always started with `selector`. Now they will consider the type provided using `initialType` as an option: | ||
| ```js | ||
| .parameter('myToggle', { | ||
| type: 'boolean' | ||
| }, { | ||
| initialType: 'boolean' | ||
| }) | ||
| ``` | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | options | <code>object</code> | Specifies additional options to configure the parameter. | | ||
| # Author | ||
| Axway <support@axway.com> https://axway.com | ||
| # Changes | ||
| #### 3.2.0 | ||
@@ -434,3 +426,4 @@ - #5891: Added alternative way to define parameter options. Instead of `false` as a third argument to `.parameter()`, an object can be provided as `{ required: false }`. | ||
| #### 3.1.11 | ||
| - #5923: Fixes for both the README.md not being published and the wrong .README.md template. | ||
| - #5923: Fix issue where README.md was not published. | ||
| - #5923: Fix issue where README.md was generated with hardcoded docs. | ||
@@ -441,3 +434,3 @@ #### 3.1.10 | ||
| #### 3.1.9 | ||
| - #5887: Fix the issue where the `axway-flow -n` command would throw an error | ||
| - #5887: Fix issue where the `axway-flow -n` command would throw an error | ||
@@ -444,0 +437,0 @@ #### 3.1.8 |
@@ -271,6 +271,7 @@ const axwayFlowSchema = require('axway-flow-schema'); | ||
| * @param {boolean} options.required - specifies that the parameter is required. Parameters are required by default. | ||
| * @param {object} options.multilineWrapper - object that holds the before and after parts that surrounds user provided value in the UI. | ||
| * @param {string} options.multilineWrapper.before - string that is placed before the user provided value in the UI. | ||
| * @param {string} options.multilineWrapper.after - string that is placed after the user provided value in the UI. | ||
| * @param {string} options.initialType - autoselects the input type of the field in the ui | ||
| * @param {object} options.multilineWrapper - describes the before and after parts that surrounds user provided value in the UI. | ||
| * @param {string} options.multilineWrapper.before - read-only string that is placed before the user provided value in the UI. | ||
| * @param {string} options.multilineWrapper.after - read-only string that is placed after the user provided value in the UI. | ||
| * @param {string} options.initialType - The type to display by default in the UI for this parameter. | ||
| * Allowed values are object, array, string, selector, null, boolean and number. | ||
@@ -309,3 +310,3 @@ * @return {NodeBuilder} The current object (this). | ||
| // Create schema.options with allowed options | ||
| for (const option of [ 'multilineWrapper' ]) { | ||
| for (const option of [ 'multilineWrapper', 'initialType' ]) { | ||
| if (options[option] !== undefined) { | ||
@@ -312,0 +313,0 @@ // only initialise schema.options if we have something to add |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Dev dependency count
- decreased by-33.33%
2
- Lines of code
- increased by0.14%
709
Worsened metrics
- Total package byte prevSize
- decreased by-0.01%
51902
- Number of lines in readme file
- decreased by-1.48%
467
No dependency changes