bingo-systems 0.4.1 → 0.5.1

package/lib/fetchers/types.d.ts

@@ -1,6 +1,17 @@
 import { Octokit } from "octokit";
+/**
+ * APIs to send network requests.
+ */
 export interface SystemFetchers {
+    /**
+     * Standard fetch function to send requests.
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API}
+     */
     fetch: typeof fetch;
+    /**
+     * Octokit.js instance wrapping the same `fetch` function.
+     * @see {@link https://octokit.github.io/rest.js}
+     */
     octokit: Octokit;
 }
 //# sourceMappingURL=types.d.ts.map

package/lib/fetchers/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fetchers/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,MAAM,WAAW,cAAc;IAC9B,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fetchers/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;OAGG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;CACjB"}

package/lib/files/createWritingFileSystem.d.ts

@@ -1,7 +1,7 @@
-import { CreatedFileOptions } from "bingo-fs";
+import { CreatedFileMetadata } from "bingo-fs";
 export declare function createWritingFileSystem(): {
     writeDirectory: (directoryPath: string) => Promise<undefined>;
-    writeFile: (filePath: string, contents: string, options?: CreatedFileOptions) => Promise<void>;
+    writeFile: (filePath: string, contents: string, options?: CreatedFileMetadata) => Promise<void>;
     readDirectory: import("./types.js").ReadDirectory;
     readFile: import("./types.js").ReadFile;
 };

package/lib/files/createWritingFileSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createWritingFileSystem.d.ts","sourceRoot":"","sources":["../../src/files/createWritingFileSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAK9C,wBAAgB,uBAAuB;oCAGC,MAAM;0BAGjC,MAAM,YACN,MAAM,YACN,kBAAkB;;;EAS9B"}
+{"version":3,"file":"createWritingFileSystem.d.ts","sourceRoot":"","sources":["../../src/files/createWritingFileSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAK/C,wBAAgB,uBAAuB;oCAGC,MAAM;0BAGjC,MAAM,YACN,MAAM,YACN,mBAAmB;;;EAS/B"}

package/lib/files/createWritingFileSystem.js.map

@@ -1 +1 @@
-{"version":3,"file":"createWritingFileSystem.js","sourceRoot":"","sources":["../../src/files/createWritingFileSystem.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,UAAU,uBAAuB;IACtC,OAAO;QACN,GAAG,uBAAuB,EAAE;QAC5B,cAAc,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE,CAC/C,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,SAAS,EAAE,KAAK,EACf,QAAgB,EAChB,QAAgB,EAChB,OAA4B,EAC3B,EAAE;YACH,MAAM,EAAE,CAAC,SAAS,CACjB,QAAQ,EACR,QAAQ,EACR,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CACjD,CAAC;QACH,CAAC;KACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"createWritingFileSystem.js","sourceRoot":"","sources":["../../src/files/createWritingFileSystem.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,UAAU,uBAAuB;IACtC,OAAO;QACN,GAAG,uBAAuB,EAAE;QAC5B,cAAc,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE,CAC/C,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,SAAS,EAAE,KAAK,EACf,QAAgB,EAChB,QAAgB,EAChB,OAA6B,EAC5B,EAAE;YACH,MAAM,EAAE,CAAC,SAAS,CACjB,QAAQ,EACR,QAAQ,EACR,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CACjD,CAAC;QACH,CAAC;KACD,CAAC;AACH,CAAC"}

package/lib/files/types.d.ts

@@ -1,20 +1,61 @@
-export interface DirectoryChild {
-    name: string;
-    type: "directory" | "file";
-}
-export type ReadDirectory = (filePath: string) => Promise<string[]>;
+/**
+ * Reads the names of a directory's children.
+ * @param directoryPath Path to the directory on disk.
+ * @returns Promise for the names of the directory's children.
+ */
+export type ReadDirectory = (directoryPath: string) => Promise<string[]>;
+/**
+ * Reads the contents of a file.
+ * @param filePath Path to the file on disk.
+ * @returns Promise for the text contents of the file.
+ */
 export type ReadFile = (filePath: string) => Promise<string>;
+/**
+ * APIs to read from a file system.
+ */
 export interface ReadingFileSystem {
+    /**
+     * Reads the names of a directory's children.
+     */
     readDirectory: ReadDirectory;
+    /**
+     * Reads the contents of a file.
+     */
     readFile: ReadFile;
 }
+/**
+ * Creates a directory if it doesn't yet exist.
+ * @param directoryPath Path to the directory on disk.
+ */
 export type WriteDirectory = (directoryPath: string) => Promise<void>;
+/**
+ * Writes contents to a file, updating it if it already exists.
+ * @param filePath Path to the file on disk.
+ * @param contents New contents for the file.
+ * @param options Extra metadata to attach to the file.
+ * @returns Promise for the text contents of the file.
+ */
 export type WriteFile = (filePath: string, contents: string, options?: WriteFileOptions) => Promise<void>;
+/**
+ * Extra metadata for writing a file.
+ */
 export interface WriteFileOptions {
+    /**
+     * Whether the file has an executable bit enabled.
+     */
     executable?: boolean;
 }
+/**
+ * APIs to read from and write to a file system.
+ */
 export interface WritingFileSystem extends ReadingFileSystem {
+    /**
+     * Creates a directory if it doesn't yet exist.
+     */
     writeDirectory: WriteDirectory;
+    /**
+     * Writes contents to a file, updating it if it already exists.
+     */
     writeFile: WriteFile;
 }
 //# sourceMappingURL=types.d.ts.map

package/lib/files/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/files/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAEpE,MAAM,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,WAAW,iBAAiB;IACjC,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,gBAAgB,KACtB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,WAAW,gBAAgB;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC3D,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,SAAS,CAAC;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/files/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAEzE;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,gBAAgB,KACtB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC3D;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACrB"}

package/lib/runner/runner.d.ts

@@ -1,3 +1,7 @@
 import { ExecaError, Result } from "execa";
+/**
+ * Executes a command in the system shell.
+ * @see {@link https://github.com/sindresorhus/execa}
+ */
 export type SystemRunner = (command: string) => Promise<ExecaError | Result>;
 //# sourceMappingURL=runner.d.ts.map

package/lib/runner/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/runner/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/runner/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE3C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC"}

package/lib/types/system.d.ts

@@ -1,9 +1,21 @@
 import { SystemFetchers } from "../fetchers/types.js";
 import { WritingFileSystem } from "../files/types.js";
 import { SystemRunner } from "../runner/runner.js";
+/**
+ * Shared APIs used by Bingo preparers, producers, and runners.
+ */
 export interface BingoSystem {
+    /**
+     * APIs to send network requests.
+     */
     fetchers: SystemFetchers;
+    /**
+     * APIs to read from and write to a file system.
+     */
     fs: WritingFileSystem;
+    /**
+     * Executes a command in the system shell.
+     */
     runner: SystemRunner;
 }
 //# sourceMappingURL=system.d.ts.map

package/lib/types/system.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../src/types/system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,WAAW,WAAW;IAC3B,QAAQ,EAAE,cAAc,CAAC;IACzB,EAAE,EAAE,iBAAiB,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;CACrB"}
+{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../src/types/system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;IAEzB;;OAEG;IACH,EAAE,EAAE,iBAAiB,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bingo-systems",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "description": "File, network, and shell wrapper APIs used by Bingo. 🧰",
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
     "execa": "^9.5.2",
     "get-github-auth-token": "^0.1.1",
     "octokit": "^4.1.2",
-    "bingo-fs": "^0.4.1"
+    "bingo-fs": "^0.5.1"
   },
   "devDependencies": {
     "@types/node": "22.13.4"