chore: Add in some more types and tools

healthUtil.ts

@@ -1,4 +1,5 @@
-import { Effects, ExpectedExports, ResultType } from "./types.ts";
+import { Effects, ResultType } from "./types.ts";
+import { error, errorCode, ok } from "./util.ts";
 
 export const checkWebUrl: (
   url: string,
@@ -19,15 +20,9 @@ export const checkWebUrl: (
   };
 
 // Ensure the starting duration is pass a minimum
-const guardDurationAboveMinimum = (
+export const guardDurationAboveMinimum = (
   input: { duration: number; minimumTime: number },
 ) =>
   (input.duration <= input.minimumTime)
     ? Promise.reject(errorCode(60, "Starting"))
     : null;
-
-const errorCode = (code: number, error: string) => ({
-  "error-code": [code, error] as const,
-});
-const error = (error: string) => ({ error });
-const ok = { result: null };

types.ts

@@ -32,6 +32,12 @@ export namespace ExpectedExports {
       config?: Config,
     ) => Promise<ResultType<ActionResult>>;
   };
+
+  /**
+   * This is the entrypoint for the main container. Used to start up something like the service that the
+   * package represents, like running a bitcoind in a bitcoind-wrapper.
+   */
+  export type main = (effects: Effects) => Promise<ResultType<null | void>>;
 }
 
 /** Used to reach out from the pure js runtime */
@@ -58,25 +64,23 @@ export type Effects = {
     input: { volumeId: string; path: string },
   ): Promise<Record<string, unknown>>;
 
-
   runCommand(
     input: {
-      command: string,
+      command: string;
-      args?: string[],
+      args?: string[];
-      timeoutMillis?: number
+      timeoutMillis?: number;
     },
   ): Promise<ResultType<string>>;
   runDaemon(
     input: {
-      command: string,
+      command: string;
-      args?: string[],
+      args?: string[];
     },
   ): {
-    wait(): Promise<ResultType<string>>,
+    wait(): Promise<ResultType<string>>;
-    term(): Promise<void>
+    term(): Promise<void>;
   };
 
-
   sleep(
     timeMs: number,
   ): Promise<null>;
@@ -99,12 +103,12 @@ export type Effects = {
 
   fetch(url: string, options?: {
     method?:
-    | "GET"
+      | "GET"
-    | "POST"
+      | "POST"
-    | "PUT"
+      | "PUT"
-    | "DELETE"
+      | "DELETE"
-    | "HEAD"
+      | "HEAD"
-    | "PATCH";
+      | "PATCH";
     headers?: Record<string, string>;
     body?: string;
   }): Promise<{
@@ -363,39 +367,39 @@ export type ValueSpecEnum = {
 export type SetResult = {
   /** These are the unix process signals */
   signal:
-  | "SIGTERM"
+    | "SIGTERM"
-  | "SIGHUP"
+    | "SIGHUP"
-  | "SIGINT"
+    | "SIGINT"
-  | "SIGQUIT"
+    | "SIGQUIT"
-  | "SIGILL"
+    | "SIGILL"
-  | "SIGTRAP"
+    | "SIGTRAP"
-  | "SIGABRT"
+    | "SIGABRT"
-  | "SIGBUS"
+    | "SIGBUS"
-  | "SIGFPE"
+    | "SIGFPE"
-  | "SIGKILL"
+    | "SIGKILL"
-  | "SIGUSR1"
+    | "SIGUSR1"
-  | "SIGSEGV"
+    | "SIGSEGV"
-  | "SIGUSR2"
+    | "SIGUSR2"
-  | "SIGPIPE"
+    | "SIGPIPE"
-  | "SIGALRM"
+    | "SIGALRM"
-  | "SIGSTKFLT"
+    | "SIGSTKFLT"
-  | "SIGCHLD"
+    | "SIGCHLD"
-  | "SIGCONT"
+    | "SIGCONT"
-  | "SIGSTOP"
+    | "SIGSTOP"
-  | "SIGTSTP"
+    | "SIGTSTP"
-  | "SIGTTIN"
+    | "SIGTTIN"
-  | "SIGTTOU"
+    | "SIGTTOU"
-  | "SIGURG"
+    | "SIGURG"
-  | "SIGXCPU"
+    | "SIGXCPU"
-  | "SIGXFSZ"
+    | "SIGXFSZ"
-  | "SIGVTALRM"
+    | "SIGVTALRM"
-  | "SIGPROF"
+    | "SIGPROF"
-  | "SIGWINCH"
+    | "SIGWINCH"
-  | "SIGIO"
+    | "SIGIO"
-  | "SIGPWR"
+    | "SIGPWR"
-  | "SIGSYS"
+    | "SIGSYS"
-  | "SIGEMT"
+    | "SIGEMT"
-  | "SIGINFO";
+    | "SIGINFO";
   "depends-on": DependsOn;
 };
 

util.ts

@@ -15,3 +15,9 @@ export const exists = (
   effects: T.Effects,
   props: { path: string; volumeId: string },
 ) => effects.metadata(props).then((_) => true, (_) => false);
+
+export const errorCode = (code: number, error: string) => ({
+  "error-code": [code, error] as const,
+});
+export const error = (error: string) => ({ error });
+export const ok = { result: null };