@heroku-cli/heroku-connect-plugin 0.11.5-beta.0 → 0.12.0-beta.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@heroku-cli/heroku-connect-plugin",
   "description": "Heroku Connect CLI plugin",
-  "version": "0.11.5-beta.0",
+  "version": "0.12.0-beta.0",
   "author": "Heroku",
   "repository": {
     "type": "git",
@@ -14,16 +14,38 @@
     "heroku-plugin"
   ],
   "license": "Apache-2.0",
-  "main": "index.js",
+  "type": "module",
   "files": [
-    "/index.js",
+    "/commands",
     "/lib",
-    "/commands"
+    "oclif.manifest.json"
   ],
+  "oclif": {
+    "bin": "heroku",
+    "commands": "./commands",
+    "topics": {
+      "connect": {
+        "description": "manage connections for Heroku Connect"
+      },
+      "connect:mapping": {
+        "description": "manage mappings on a Heroku Connect addon"
+      },
+      "connect:notifications": {
+        "description": "manage notifications on a Heroku Connect addon"
+      },
+      "connect-events": {
+        "description": "manage connections for Heroku Connect Events Pilot"
+      },
+      "connect-events:stream": {
+        "description": "manage mappings on a Heroku Connect Events Pilot addon"
+      }
+    }
+  },
   "dependencies": {
+    "@heroku-cli/command": "^12.2.1",
     "@heroku/heroku-cli-util": "^8.0.15",
-    "axios": "^1.12.0",
-    "co": "4.6.0",
+    "@oclif/core": "^4.8.4",
+    "axios": "^1.13.5",
     "heroku-client": "^3.0.6",
     "inquirer": "^8.2.7"
   },
@@ -34,6 +56,7 @@
     "mocha": "^11.0.1",
     "mockdate": "^3.0.5",
     "nock": "^14.0.10",
+    "oclif": "^4.22.81",
     "sinon": "^21.0.0",
     "standard": "^17.1.0",
     "unexpected": "^13.2.1"
@@ -43,8 +66,13 @@
       "workflows-repo/**"
     ]
   },
+  "resolutions": {
+    "serialize-javascript": "^7.0.3"
+  },
   "scripts": {
-    "test": "CONNECT_ADDON=connectqa mocha && standard",
-    "style-fix": "standard --fix"
+    "test": "CONNECT_ADDON=connectqa mocha",
+    "posttest": "standard",
+    "style-fix": "standard --fix",
+    "build": "oclif manifest"
   }
 }

package/commands/connect/db-set.js

@@ -1,69 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-const inquirer = require('inquirer')
-
-const fetchKeys = co.wrap(function * (appName, context) {
-  const url = '/api/v3/apps/' + appName
-  const response = yield api.request(context, 'GET', url)
-  const keys = []// new Array(response.json.db_keys.length);
-  response.data.db_keys.forEach(function (key) {
-    const plan = (key.addon ? key.addon.plan : null) || 'Unknown Plan'
-    keys.push({
-      name: `${key.name} (${plan})`,
-      value: key.name
-    })
-  })
-  return yield Promise.resolve(keys)
-})
-
-module.exports = {
-  topic: 'connect',
-  command: 'db:set',
-  description: 'Set database parameters',
-  help: "Set a connection's database config var and schema name",
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true },
-    { name: 'db', description: 'Database config var name', hasValue: true },
-    { name: 'schema', description: 'Database schema name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    const data = {
-      db_key: context.flags.db,
-      schema_name: context.flags.schema
-    }
-
-    const connection = yield api.withConnection(context, heroku)
-    context.region = connection.region_url
-
-    inquirer.prompt([
-      {
-        name: 'db_key',
-        type: 'list',
-        message: "Select the config var that points to the database you'd like to use",
-        choices: yield fetchKeys(connection.app_name, context),
-        when: !context.flags.db
-      },
-      {
-        name: 'schema_name',
-        message: "Enter a schema name you'd like to use for the conneted data",
-        default: context.flags.schema || 'salesforce',
-        when: !context.flags.schema
-      }
-    ]).then(co.wrap(function * (answers) {
-      for (const key in answers) {
-        data[key] = answers[key]
-      }
-
-      yield cli.action('setting database parameters', co(function * () {
-        const url = '/api/v3/connections/' + connection.id
-        yield api.request(context, 'PATCH', url, data)
-      }))
-
-      cli.styledHash(data)
-    }))
-  }))
-}

package/commands/connect/mapping-delete.js

@@ -1,33 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect:mapping',
-  command: 'delete',
-  description: 'Delete an existing mapping',
-  help: 'Delete an existing mapping',
-  args: [
-    { name: 'mapping' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true },
-    { name: 'confirm', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    yield cli.confirmApp(context.app, context.flags.confirm)
-
-    yield cli.action('deleting mapping', co(function * () {
-      const connection = yield api.withConnection(context, heroku)
-      context.region = connection.region_url
-      const mapping = yield api.withMapping(connection, context.args.mapping)
-      const response = yield api.request(context, 'DELETE', '/api/v3/mappings/' + mapping.id)
-      if (response.status !== 204) {
-        throw new Error(response.data.message || 'unknown error')
-      }
-    }))
-  }))
-}

package/commands/connect/mapping-diagnose.js

@@ -1,33 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-const diagnose = require('./diagnose')
-
-module.exports = {
-  topic: 'connect:mapping',
-  command: 'diagnose',
-  description: 'Display diagnostic information about a mapping',
-  help: 'Checks a mapping for common configuration errors. ',
-  args: [
-    { name: 'mapping' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true },
-    { name: 'verbose', char: 'v', description: 'display passed and skipped check information as well' }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    const connection = yield api.withConnection(context, heroku)
-    context.region = connection.region_url
-    const mapping = yield api.withMapping(connection, context.args.mapping)
-    const results = yield cli.action('Diagnosing mapping', co(function * () {
-      const url = '/api/v3/mappings/' + mapping.id + '/validations'
-      return yield api.request(context, 'GET', url)
-    }))
-    cli.log() // Blank line to separate each section
-    cli.styledHeader(mapping.object_name)
-    diagnose.displayResults(results.data, context.flags)
-  }))
-}

package/commands/connect/mapping-reload.js

@@ -1,31 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect:mapping',
-  command: 'reload',
-  description: "Reload a mapping's data from Salesforce",
-  help: "Reload a mapping's data from Salesforce",
-  args: [
-    { name: 'mapping' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    yield cli.action(`initiating reload of ${context.args.mapping}`, co(function * () {
-      const connection = yield api.withConnection(context, heroku)
-      context.region = connection.region_url
-      const mapping = yield api.withMapping(connection, context.args.mapping)
-
-      const response = yield api.request(context, 'POST', '/api/v3/mappings/' + mapping.id + '/actions/reload')
-      if (response.status !== 202) {
-        throw new Error(response.data.message || 'unknown error')
-      }
-    }))
-  }))
-}

package/commands/connect/mapping-state.js

@@ -1,26 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect:mapping',
-  command: 'state',
-  description: 'return a mapping state',
-  help: 'return a mapping state',
-  args: [
-    { name: 'mapping' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    const connection = yield api.withConnection(context, heroku)
-    context.region = connection.region_url
-    const mapping = yield api.withMapping(connection, context.args.mapping)
-
-    cli.log(mapping.state)
-  }))
-}

package/commands/connect/mapping-write-errors.js

@@ -1,34 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-
-module.exports = {
-  topic: 'connect:mapping',
-  command: 'write-errors',
-  description: 'Display the last 24 hours of write errors on this mapping',
-  examples: [
-    '$ heroku connect:mapping:write-errors -a myapp --resource herokuconnect-twisted-123 Account'
-  ],
-  args: [
-    {
-      name: 'name',
-      optional: false,
-      description: 'Name of the mapping to retrieve errors for'
-    }
-  ],
-  flags: [
-    {
-      name: 'resource',
-      description: 'specific connection resource name',
-      hasValue: true
-    },
-    {
-      name: 'json',
-      description: 'print errors as styled JSON',
-      hasValue: false
-    }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(api.getWriteErrors)
-}

package/commands/connect/sf-auth.js

@@ -1,76 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-const http = require('http')
-
-const LOCAL_PORT = 18000
-
-function callbackServer () {
-  return new Promise(function (resolve, reject) {
-    // Create a local server that can receive the user after authoriztion is complete
-    http.createServer(function (request, response) {
-      // Notify the user that the the authorization is complete
-      response.writeHead(200, { 'Content-Type': 'text/html' })
-      const res = '<html><body><h3>Authorization complete</h3><p>You may close this window and return to the terminal to continue.</p></body></html>'
-      response.end(res)
-
-      // Shut down the server so the command can exit
-      request.socket.destroy()
-      this.close()
-
-      // Return control to the main command
-      resolve()
-    }).listen(LOCAL_PORT)
-  })
-}
-
-function * run (context, heroku) {
-  let redir
-  yield cli.action('fetching authorizing URL', co(function * () {
-    const connection = yield api.withConnection(context, heroku)
-    context.region = connection.region_url
-
-    const url = `/api/v3/connections/${connection.id}/authorize_url`
-    const args = {
-      environment: 'production',
-      // Redirect to the local server created in callbackServer(), so the CLI
-      // can respond immediately after successful authorization
-      next: `http://localhost:${LOCAL_PORT}`
-    }
-
-    if (context.flags.environment) {
-      args.environment = context.flags.environment
-    }
-
-    if (context.flags.environment === 'custom' && context.flags.domain) {
-      args.domain = context.flags.domain
-    }
-
-    const response = yield api.request(context, 'POST', url, args)
-    redir = response.data.redirect
-
-    yield cli.open(redir)
-  }))
-
-  cli.log("\nIf your browser doesn't open, please copy the following URL to proceed:\n" + redir + '\n')
-
-  yield cli.action('waiting for authorization', module.exports.callbackServer())
-}
-
-module.exports = {
-  topic: 'connect',
-  command: 'sf:auth',
-  description: 'Authorize access to Salesforce for your connection',
-  help: 'Opens a browser to authorize a connection to a Salesforce Org',
-  flags: [
-    { name: 'callback', char: 'c', description: 'final callback URL', hasValue: true },
-    { name: 'environment', char: 'e', description: '"production", "sandbox", or "custom" [defaults to "production"]', hasValue: true },
-    { name: 'domain', char: 'd', description: 'specify a custom login domain (if using a "custom" environment)', hasValue: true },
-    { name: 'resource', description: 'specific connection resource name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(run)),
-  callbackServer
-}

package/commands/connect-events/db-set.js

@@ -1,68 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-const inquirer = require('inquirer')
-
-const fetchKeys = co.wrap(function * (appName, context) {
-  const url = `/api/v3/apps/${appName}`
-  const response = yield api.request(context, 'GET', url)
-  const keys = []// new Array(response.json.db_keys.length);
-  response.data.db_keys.forEach(function (key) {
-    keys.push({
-      name: `${key.name} (${key.addon.plan})`,
-      value: key.name
-    })
-  })
-  return yield Promise.resolve(keys)
-})
-
-module.exports = {
-  topic: 'connect-events',
-  command: 'db:set',
-  description: 'Set database parameters',
-  help: "Set a connection's database config var and schema name",
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true },
-    { name: 'db', description: 'Database config var name', hasValue: true },
-    { name: 'schema', description: 'Database schema name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    const data = {
-      db_key: context.flags.db,
-      schema_name: context.flags.schema
-    }
-
-    const connection = yield api.withConnection(context, heroku, api.ADDON_TYPE_EVENTS)
-    context.region = connection.region_url
-
-    inquirer.prompt([
-      {
-        name: 'db_key',
-        type: 'list',
-        message: "Select the config var that points to the database you'd like to use",
-        choices: yield fetchKeys(connection.app_name, context),
-        when: !context.flags.db
-      },
-      {
-        name: 'schema_name',
-        message: "Enter a schema name you'd like to use for the conneted data",
-        default: context.flags.schema || 'salesforce',
-        when: !context.flags.schema
-      }
-    ]).then(co.wrap(function * (answers) {
-      for (const key in answers) {
-        data[key] = answers[key]
-      }
-
-      yield cli.action('setting database parameters', co(function * () {
-        const url = `/api/v3/kafka-connections/${connection.id}`
-        yield api.request(context, 'PUT', url, data)
-      }))
-
-      cli.styledHash(data)
-    }))
-  }))
-}

package/commands/connect-events/stream-create.js

@@ -1,32 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect-events:stream',
-  command: 'create',
-  description: 'Create a stream',
-  help: 'Create a stream',
-  args: [
-    { name: 'stream' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    yield cli.action('creating stream', co(function * () {
-      const connection = yield api.withConnection(context, heroku, api.ADDON_TYPE_EVENTS)
-      context.region = connection.region_url
-      const response = yield api.request(
-        context, 'POST', `/api/v3/kafka-connections/${connection.id}/streams`,
-        { object_name: context.args.stream }
-      )
-      if (response.status !== 201) {
-        throw new Error(response.data.message || 'unknown error')
-      }
-    }))
-  }))
-}

package/commands/connect-events/stream-delete.js

@@ -1,33 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect-events:stream',
-  command: 'delete',
-  description: 'Delete an existing stream',
-  help: 'Delete an existing stream',
-  args: [
-    { name: 'stream' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true },
-    { name: 'confirm', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    yield cli.confirmApp(context.app, context.flags.confirm)
-
-    yield cli.action('deleting stream', co(function * () {
-      const connection = yield api.withConnection(context, heroku, api.ADDON_TYPE_EVENTS)
-      context.region = connection.region_url
-      const stream = yield api.withStream(context, connection, context.args.stream)
-      const response = yield api.request(context, 'DELETE', `/api/v3/streams/${stream.id}`)
-      if (response.status !== 204) {
-        throw new Error(response.data.message || 'unknown error')
-      }
-    }))
-  }))
-}

package/commands/connect-events/stream-state.js

@@ -1,26 +0,0 @@
-'use strict'
-const api = require('../../lib/connect/api.js')
-const cli = require('@heroku/heroku-cli-util')
-const co = require('co')
-
-module.exports = {
-  topic: 'connect-events:stream',
-  command: 'state',
-  description: 'return a stream state',
-  help: 'return a stream state',
-  args: [
-    { name: 'stream' }
-  ],
-  flags: [
-    { name: 'resource', description: 'specific connection resource name', hasValue: true }
-  ],
-  needsApp: true,
-  needsAuth: true,
-  run: cli.command(co.wrap(function * (context, heroku) {
-    const connection = yield api.withConnection(context, heroku, api.ADDON_TYPE_EVENTS)
-    context.region = connection.region_url
-    const stream = yield api.withStream(context, connection, context.args.stream)
-
-    cli.log(stream.state)
-  }))
-}

package/index.js

@@ -1,50 +0,0 @@
-'use strict'
-exports.topics = [
-  {
-    name: 'connect',
-    description: 'manage connections for Heroku Connect'
-  },
-  {
-    name: 'connect:mapping',
-    description: 'manage mappings on a Heroku Connect addon'
-  },
-  {
-    name: 'connect-events',
-    description: 'manage connections for Heroku Connect Events Pilot'
-  },
-  {
-    name: 'connect-events:stream',
-    description: 'manage mappings on a Heroku Connect Events Pilot addon'
-  }
-]
-
-exports.commands = [
-  require('./commands/connect/info'),
-  require('./commands/connect/state'),
-  require('./commands/connect/import'),
-  require('./commands/connect/export'),
-  require('./commands/connect/pause'),
-  require('./commands/connect/resume'),
-  require('./commands/connect/recover'),
-  require('./commands/connect/sf-auth'),
-  require('./commands/connect/db-set'),
-  require('./commands/connect/diagnose'),
-  require('./commands/connect/mapping-state'),
-  require('./commands/connect/mapping-delete'),
-  require('./commands/connect/mapping-reload'),
-  require('./commands/connect/mapping-diagnose'),
-  require('./commands/connect/mapping-write-errors'),
-  require('./commands/connect/write-errors'),
-
-  // Connect Events
-  require('./commands/connect-events/info'),
-  require('./commands/connect-events/state'),
-  require('./commands/connect-events/pause'),
-  require('./commands/connect-events/resume'),
-  require('./commands/connect-events/recover'),
-  require('./commands/connect-events/sf-auth'),
-  require('./commands/connect-events/db-set'),
-  require('./commands/connect-events/stream-state'),
-  require('./commands/connect-events/stream-delete'),
-  require('./commands/connect-events/stream-create')
-]