feat: plugin API

Author: gr2m

index.js

@@ -1,28 +1,9 @@
-module.exports = GitHubApi
+const factory = require('./lib/factory')
 
-const endpoint = require('@octokit/request').endpoint
-const Hook = require('before-after-hook')
-
-const parseClientOptions = require('./lib/parse-client-options')
-const requestWithDefaults = require('./lib/request-with-defaults')
-
-const PLUGINS = [
-  require('./lib/plugins/authentication'),
-  require('./lib/plugins/endpoint-methods'),
-  require('./lib/plugins/pagination')
+const CORE_PLUGINS = [
+  require('./plugins/authentication'),
+  require('./plugins/endpoint-methods'),
+  require('./plugins/pagination')
 ]
 
-function GitHubApi (options) {
-  const hook = new Hook()
-  const api = {
-    // NOTE: github.hook and github.plugin are experimental APIs
-    //       at this point and can change at any time
-    hook,
-    plugin: (pluginFunction) => pluginFunction(api),
-    request: requestWithDefaults(hook, endpoint, parseClientOptions(options))
-  }
-
-  PLUGINS.forEach(api.plugin)
-
-  return api
-}
+module.exports = factory(CORE_PLUGINS)

lib/constructor.js

@@ -0,0 +1,19 @@
+module.exports = Octokit
+
+const endpoint = require('@octokit/request').endpoint
+const Hook = require('before-after-hook')
+
+const parseClientOptions = require('./parse-client-options')
+const requestWithDefaults = require('./request-with-defaults')
+
+function Octokit (plugins, options) {
+  const hook = new Hook()
+  const api = {
+    hook,
+    request: requestWithDefaults(hook, endpoint, parseClientOptions(options))
+  }
+
+  plugins.forEach(pluginFunction => pluginFunction(api, options))
+
+  return api
+}

lib/factory.js

@@ -0,0 +1,10 @@
+module.exports = factory
+
+const Octokit = require('./constructor')
+const registerPlugin = require('./register-plugin')
+
+function factory (plugins) {
+  const Api = Octokit.bind(null, plugins)
+  Api.plugin = registerPlugin.bind(null, plugins)
+  return Api
+}

lib/plugins/README.md

@@ -0,0 +1,7 @@
+module.exports = registerPlugin
+
+const factory = require('./factory')
+
+function registerPlugin (plugins, pluginFunction) {
+  return factory(plugins.concat(pluginFunction))
+}

lib/register-plugin.js

@@ -3,7 +3,7 @@ module.exports = authenticationBeforeRequest
 const btoa = require('btoa-lite')
 const uniq = require('lodash/uniq')
 
-const deprecate = require('../../deprecate')
+const deprecate = require('../../lib/deprecate')
 
 function authenticationBeforeRequest (state, options) {
   if (!state.auth.type) {

lib/plugins/authentication/authenticate.js renamed to plugins/authentication/authenticate.js

@@ -5,7 +5,7 @@ module.exports = apiPlugin
 const set = require('lodash/set')
 
 const validate = require('./validate')
-const ENDPOINT_DEFAULTS = require('../../routes.json')
+const ENDPOINT_DEFAULTS = require('./routes.json')
 
 function apiPlugin (octokit) {
   octokit.hook.before('request', validate)