feat: octokit.request()

Author: gr2m

src/index.ts

@@ -1,4 +1,8 @@
-import { OctokitOptions, Plugin } from "./types";
+import getUserAgent from "universal-user-agent";
+import { request } from "@octokit/request";
+
+import { OctokitOptions, Parameters, Plugin } from "./types";
+import { VERSION } from "./version";
 
 export class Octokit {
   static plugins: Plugin[] = [];
@@ -13,12 +17,44 @@ export class Octokit {
     };
   }
 
-  constructor(options?: OctokitOptions) {
+  constructor(options: OctokitOptions = {}) {
+    const requestDefaults: Required<Parameters> = {
+      baseUrl: request.endpoint.DEFAULTS.baseUrl,
+      headers: {},
+      request: options.request || {},
+      mediaType: {
+        previews: [],
+        format: ""
+      }
+    };
+
+    // prepend default user agent with `options.userAgent` if set
+    requestDefaults.headers["user-agent"] = [
+      options.userAgent,
+      `octokit-core.js/${VERSION} ${getUserAgent()}`
+    ]
+      .filter(Boolean)
+      .join(" ");
+
+    if (options.baseUrl) {
+      requestDefaults.baseUrl = options.baseUrl;
+    }
+
+    if (options.previews) {
+      requestDefaults.mediaType.previews = options.previews;
+    }
+
+    this.request = request.defaults(requestDefaults);
+
+    // apply plugins
     // https://stackoverflow.com/a/16345172
     const classConstructor = this.constructor as typeof Octokit;
     classConstructor.plugins.forEach(plugin => plugin(this, options));
   }
 
+  // assigned during constructor
+  request: typeof request;
+
   // allow for plugins to extend the Octokit instance
   [key: string]: any;
 }

src/types.ts

@@ -1,7 +1,101 @@
+import { Agent } from "http";
+
 import { Octokit } from ".";
 
 export type OctokitOptions = {
+  request?: OctokitRequestOptions;
   [option: string]: any;
 };
 
 export type Plugin = (octokit: Octokit, options?: OctokitOptions) => void;
+
+// TODO: deduplicate
+
+/**
+ * Endpoint parameters
+ */
+export type Parameters = {
+  /**
+   * Base URL to be used when a relative URL is passed, such as `/orgs/:org`.
+   * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request
+   * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`.
+   */
+  baseUrl?: string;
+
+  /**
+   * HTTP headers. Use lowercase keys.
+   */
+  headers?: RequestHeaders;
+
+  /**
+   * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide}
+   */
+  mediaType?: {
+    /**
+     * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint
+     */
+    format?: string;
+
+    /**
+     * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix.
+     * Example for single preview: `['squirrel-girl']`.
+     * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`.
+     */
+    previews?: string[];
+  };
+
+  /**
+   * Pass custom meta information for the request. The `request` object will be returned as is.
+   */
+  request?: OctokitRequestOptions;
+
+  /**
+   * Any additional parameter will be passed as follows
+   * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url`
+   * 2. Query parameter if `method` is `'GET'` or `'HEAD'`
+   * 3. Request body if `parameter` is `'data'`
+   * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'`
+   */
+  [parameter: string]: any;
+};
+
+export type RequestHeaders = {
+  /**
+   * Avoid setting `accept`, use `mediaFormat.{format|previews}` instead.
+   */
+  accept?: string;
+  /**
+   * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678`
+   */
+  authorization?: string;
+  /**
+   * `user-agent` is set do a default and can be overwritten as needed.
+   */
+  "user-agent"?: string;
+
+  [header: string]: string | number | undefined;
+};
+
+export type Fetch = any;
+export type Signal = any;
+
+export type OctokitRequestOptions = {
+  /**
+   * Node only. Useful for custom proxy, certificate, or dns lookup.
+   */
+  agent?: Agent;
+  /**
+   * Custom replacement for built-in fetch method. Useful for testing or request hooks.
+   */
+  fetch?: Fetch;
+  /**
+   * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests.
+   */
+  signal?: Signal;
+  /**
+   * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead.
+   */
+  timeout?: number;
+
+  [option: string]: any;
+};

src/version.ts

@@ -0,0 +1 @@
+export const VERSION = "0.0.0-development";