package.json

{
  "name": "@twilio-labs/plugin-flex",
  "version": "7.1.1",
  "description": "Create, develop and deploy Flex plugins using the Twilio CLI",
  "keywords": [
    "twilio",
    "flex",
    "twilio flex",
    "flex plugins",
    "flex plugins cli",
    "flex plugins api",
    "oclif-plugin"
  ],
  "homepage": "https://github.com/twilio/flex-plugin-builder",
  "bugs": {
    "url": "https://github.com/twilio/flex-plugin-builder/issues"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/twilio/flex-plugin-builder.git"
  },
  "license": "MIT",
  "author": "Flex Runtime <flex-runtime@twilio.com>",
  "files": [
    "/oclif.manifest.json",
    "/dist",
    "/package-lock.json",
    "LICENSE",
    "README.md",
    "package.json"
  ],
  "scripts": {
    "prebuild": "npm run clean",
    "build": "cd ../.. && tsc -p \"packages/plugin-flex/tsconfig.json\"",
    "clean": "rm -rf dist",
    "link": "twilio plugins:link .",
    "lint": "eslint --ext ts src/",
    "lint:fix": "npm run lint -- --fix",
    "prepack": "./bin/prepack",
    "postpack": "rm -f oclif.manifest.json",
    "replace-doc": "cp docs/README.md README.md && oclif-dev readme",
    "test": "cd ../.. && jest packages/plugin-flex --color",
    "test:watch": "cd ../.. && jest packages/plugin-flex --watch --color"
  },
  "dependencies": {
    "@oclif/command": "1.8.0",
    "@oclif/config": "^1.18.1",
    "@oclif/errors": "^1.3.5",
    "@oclif/parser": "^3.8.5",
    "@twilio/cli-core": "^7.19.1",
    "@twilio/create-flex-plugin": "7.1.1",
    "@twilio/flex-dev-utils": "7.1.1",
    "@twilio/flex-plugin-scripts": "7.1.1",
    "@twilio/flex-plugins-api-client": "7.1.1",
    "dayjs": "^1.10.7",
    "lodash.startcase": "^4.4.0",
    "mkdirp": "^1.0.4",
    "package-json": "^7.0.0",
    "rimraf": "^4.0.0",
    "yargs": "^16.2.0"
  },
  "overrides": {
   "**/cheerio": "1.0.0-rc.12"
  },
  "devDependencies": {
    "@oclif/dev-cli": "^1.26.5",
    "@types/lodash.startcase": "^4.4.6",
    "@types/mkdirp": "^1.0.2",
    "@types/rimraf": "^3.0.2",
    "@types/tmp": "^0.2.2",
    "@types/yargs": "^16.0.4",
    "globby": "^11.0.4",
    "tmp": "^0.2.1",
    "twilio": "^3.71.2"
  },
  "engines": {
    "node": "^16 || ^18 || ^20 || ^22"
  },
  "publishConfig": {
    "access": "public"
  },
  "oclif": {
    "name": "flex",
    "commands": "./dist/commands",
    "bin": "twilio",
    "devPlugins": [
      "@oclif/plugin-help"
    ],
    "topics": {
      "flex": {
        "description": "Create, develop and deploy Flex plugins using the Twilio CLI."
      },
      "flex:plugins": {
        "description": "Create, develop and deploy Flex plugins using the Twilio CLI.",
        "flags": {
          "clearTerminal": "Clears the terminal before running the command.",
          "json": "Outputs the result of the command as json string."
        }
      },
      "flex:plugins:build": {
        "description": "Builds the Flex plugin and creates a JavaScript and sourcemap bundle."
      },
      "flex:plugins:test": {
        "description": "Runs the test suite."
      },
      "flex:plugins:start": {
        "description": "Starts a dev-server to build the Flex plugin locally.",
        "flags": {
          "name": "The name of the plugin you would like to run. You can provide multiple to run them all concurrently. You can include specific active remote plugins using \"--name 'plugin-name@remote'\" or \"--name 'plugin-name@0.0.0'\" for a specific remote version.",
          "includeRemote": "Use this flag to include all remote plugins in your build.",
          "port": "The port to start your local development server on."
        }
      },
      "flex:plugins:deploy": {
        "description": "Builds and deploys a new version of the Flex plugin to your Flex application.",
        "flags": {
          "patch": "Publishes the version as a patch (SemVer); this is the default.",
          "minor": "Publishes the version as a minor (SemVer).",
          "major": "Publishes the version as a major (SemVer).",
          "version": "Publishes the version (SemVer).",
          "public": "Publishes the plugin as a public Twilio Asset; default is private.",
          "changelog": "The changes (added/removed) made in this plugin version.",
          "description": "The description of this Flex plugin.",
          "option": "Option to automatically pick post validation of the plugin.",
          "bypass-validation": "Validates the plugin and continues to plugin deployment ignoring validation issues, if any."
        }
      },
      "flex:plugins:create-configuration": {
        "description": "Creates a Flex Plugin Configuration.",
        "flags": {
          "new": "Creates a new Flex Plugin Configuration, otherwise will append to existing active Configuration.",
          "name": "The friendly name of the Flex Plugin Configuration.",
          "plugin": "Alias for --enable-plugin.",
          "enablePlugin": "The plugin to enable, formatted as pluginName@version. You may use pluginName@latest as a shortcut for enabling the latest version of the plugin. Use additional --enable-plugin to provide other plugins to enable.",
          "disablePlugin": "The plugin to disable, formatted as pluginName. Use additional --disable-plugin to provide other plugins to disable.",
          "description": "The description of this Flex Plugin Configuration."
        },
        "defaults": {
          "description": "The description of this Flex Plugin Configuration."
        }
      },
      "flex:plugins:release": {
        "description": "Creates a Flex Plugin Release. Enables the plugins (passed as params or via the Flex Configuration) on your Flex application.",
        "flags": {
          "configurationSid": "The Flex Plugin Configuration SID to release; other options are not required when using this option."
        }
      },
      "flex:plugins:diff": {
        "description": "Finds the diff between two Flex Plugin Configurations.",
        "args": {
          "id1": "The first Flex Plugin Configuration SID.",
          "id2": "The second Flex Plugin Configuration SID."
        }
      },
      "flex:plugins:upgrade-plugin": {
        "description": "Upgrades your plugin to use the latest version of the Plugin CLI.",
        "flags": {
          "install": "If set, will install the dependencies.",
          "beta": "If set, will upgrade to the latest beta version.",
          "dev": "If set, will upgrade to the latest dev version.",
          "nightly": "If set, will upgrade to the latest nightly version.",
          "yes": "If set, will answer yes to all prompts.",
          "yarn": "Use yarn for installation.",
          "removeLegacyPlugin": "Deletes legacy plugin bundle hosted on Twilio Assets (deployed via plugin builder v3).",
          "flexui2": "Update your plugin dependencies to be compatible with Flex UI 2.0."
        }
      },
      "flex:plugins:archive": {
        "description": "Archives a Flex Plugin, Version or Configuration. Archived entities cannot be deployed to your Flex application and cannot be undone. Exercise extreme caution when using this command."
      },
      "flex:plugins:archive:configuration": {
        "description": "Archives a Flex Plugin Configuration. Archived Plugin Configurations cannot be deployed to your Flex application and cannot be undone. Exercise extreme caution when using this command.",
        "flags": {
          "sid": "The Flex Plugin Configuration SID to archive."
        }
      },
      "flex:plugins:archive:plugin": {
        "description": "Archives a Flex Plugin. Archived Plugins cannot be enabled on your Flex application and cannot be undone. Exercise extreme caution when using this command.",
        "flags": {
          "name": "The name of the Flex Plugin to archive."
        }
      },
      "flex:plugins:archive:plugin-version": {
        "description": "Archives a Flex Plugin Version. Archived Plugin Versions cannot be enabled on your Flex application and cannot be undone. Exercise extreme caution when using this command.",
        "flags": {
          "name": "The Flex Plugin name of the Plugin Version to archive.",
          "version": "The Flex Plugin Version to archive."
        }
      },
      "flex:plugins:describe": {
        "description": "Provides details of the Flex Plugin, Version, Configuration or Release."
      },
      "flex:plugins:describe:configuration": {
        "description": "Provides details of the Flex Plugin Configuration like status, description and its associated Plugins.",
        "flags": {
          "sid": "The Flex Plugin Configuration SID."
        }
      },
      "flex:plugins:describe:plugin": {
        "description": "Provides details of the Flex Plugin like status, description and its Flex Plugin Versions.",
        "flags": {
          "name": "The name of the Flex Plugin to describe."
        }
      },
      "flex:plugins:describe:plugin-version": {
        "description": "Provides details of the Flex Plugin Version like changelog, status and the url of the plugin package.",
        "flags": {
          "name": "The Flex Plugin name of the Plugin Version to describe.",
          "version": "The Flex Plugin Version to describe."
        }
      },
      "flex:plugins:describe:release": {
        "description": "Provides details of the Flex Plugin Release like the underlying Plugin Configuration and Plugins.",
        "flags": {
          "sid": "The Flex Plugin Release SID to describe.",
          "active": "The most recent release to describe."
        }
      },
      "flex:plugins:list": {
        "description": "Lists the Flex Plugins, Versions, Configurations or Releases on the account."
      },
      "flex:plugins:list:configurations": {
        "description": "Lists the Flex Plugin Configuration on the account."
      },
      "flex:plugins:list:plugin-versions": {
        "description": "Lists the Flex Plugin Versions on the account.",
        "flags": {
          "name": "The plugin name to list its versions."
        }
      },
      "flex:plugins:list:plugins": {
        "description": "Lists the Flex Plugins on the account."
      },
      "flex:plugins:list:releases": {
        "description": "Lists the Flex Releases on the account."
      },
      "flex:plugins:validate": {
        "description": "Validates the Flex plugin by looking for any issues that could potentially break the plugin when in use. Generates a report with the identified issues, if any.",
        "flags": {
          "flexui2": "Validates the Flex plugin for compatibility with the latest Flex UI 2.x version."
        }
      }
    }
  }
}