feat(typescript): export types for octoherd function (#38)

* test: export types for octoherd function

* feat(typescript): export types for octoherd function

Author: gr2m

index.d.ts

@@ -1,4 +1,26 @@
+import { octoherd } from "./index.js";
 import { components } from "@octokit/openapi-types";
 
 export { Octokit } from "@octoherd/octokit";
 export type Repository = components["schemas"]["repository"];
+
+export type OctoherdOptions = {
+  /** The Octoherd Script function */
+  octoherdScript: Function;
+  /** Personal Access Token: Requires the "public_repo" scope for public repositories, "repo" scope for private repositories. */
+  octoherdToken: string;
+  /** Array of repository names in the form of "repo-owner/repo-name". To match all repositories for an owner, pass "repo-owner/*" */
+  octoherdRepos: string[];
+  /** Cache responses for debugging */
+  octoherdCache: boolean;
+  /** Bypass confirmation prompts for mutating requests */
+  octoherdBypassConfirms: boolean;
+
+  /** `octoherdScript` may accept its own options */
+  [key: string]: unknown;
+};
+
+/**
+ * Find all releases in a GitHub repository or organization after a specified date
+ */
+export async function octoherd(options: OctoherdOptions): void;

index.js

@@ -13,6 +13,8 @@ import { requestConfirm } from "./lib/octokit-plugin-request-confirm.js";
 import { runScriptAgainstRepositories } from "./lib/run-script-against-repositories.js";
 import { VERSION } from "./version.js";
 
+export { Octokit } from "@octoherd/octokit";
+
 const levelColor = {
   debug: chalk.bgGray.black,
   info: chalk.bgGreen.black,
@@ -21,19 +23,12 @@ const levelColor = {
 };
 
 /**
- * Find all releases in a GitHub repository or organization after a specified date
- *
- * @param {object} options
- * @param {function} options.octoherdScript Path to script to run against a repository
- * @param {string[]} options.octoherdRepos Cache responses for debugging
- * @param {string} options.octoherdToken Personal Access Token: Requires the "public_repo" scope for public repositories, "repo" scope for private repositories.
- * @param {boolean} options.octoherdCache Array of repository names in the form of "repo-owner/repo-name". To match all repositories for an owner, pass "repo-owner/*"
+ * @param {import(".").OctoherdOptions} options
  */
 export async function octoherd(options) {
   const {
     octoherdToken,
     octoherdCache = false,
-    octoherdDebug,
     octoherdScript,
     octoherdRepos,
     octoherdBypassConfirms,
@@ -80,7 +75,6 @@ export async function octoherd(options) {
     ...authOptions,
     userAgent: ["octoherd-cli", VERSION].join("/"),
     octoherd: {
-      debug: octoherdDebug,
       cache: octoherdCache,
       bypassConfirms: octoherdBypassConfirms,
       onLogMessage(level, message, additionalData) {

tests/smoke.test.js

@@ -0,0 +1,16 @@
+import { suite } from "uvu";
+import { equal } from "uvu/assert";
+
+import * as CLI from "../index.js";
+
+const smokeTest = suite("smoke");
+
+smokeTest("exports octoherd function", () => {
+  equal(typeof CLI.octoherd, "function");
+});
+
+smokeTest("exports Octokit contructor", () => {
+  equal(typeof CLI.Octokit, "function");
+});
+
+smokeTest.run();