diff --git a/lib/types.ts b/lib/types.ts index 7d7b507..5fe170c 100644 --- a/lib/types.ts +++ b/lib/types.ts @@ -4,39 +4,24 @@ import { InputSpec } from "./config/config-types"; export namespace ExpectedExports { version: 1; /** Set configuration is called after we have modified and saved the configuration in the embassy ui. Use this to make a file for the docker to read from for configuration. */ - export type setConfig = (options: { - effects: Effects; - input: Record; - }) => Promise; + export type setConfig = (options: { effects: Effects; input: Record }) => Promise; /** Get configuration returns a shape that describes the format that the embassy ui will generate, and later send to the set config */ - export type getConfig = (options: { - effects: Effects; - config: unknown; - }) => Promise; + export type getConfig = (options: { effects: Effects; config: unknown }) => Promise; /** These are how we make sure the our dependency configurations are valid and if not how to fix them. */ export type dependencies = Dependencies; /** For backing up service data though the embassyOS UI */ - export type createBackup = (options: { - effects: Effects; - }) => Promise; + export type createBackup = (options: { effects: Effects }) => Promise; /** For restoring service data that was previously backed up using the embassyOS UI create backup flow. Backup restores are also triggered via the embassyOS UI, or doing a system restore flow during setup. */ - export type restoreBackup = (options: { - effects: Effects; - }) => Promise; + export type restoreBackup = (options: { effects: Effects }) => Promise; /** Properties are used to get values from the docker, like a username + password, what ports we are hosting from */ - export type properties = (options: { - effects: Effects; - }) => Promise; + export type properties = (options: { effects: Effects }) => Promise; /** Health checks are used to determine if the service is working properly after starting * A good use case is if we are using a web server, seeing if we can get to the web server. */ export type health = { /** Should be the health check id */ - [id: string]: (options: { - effects: Effects; - input: TimeMs; - }) => Promise; + [id: string]: (options: { effects: Effects; input: TimeMs }) => Promise; }; /** @@ -45,36 +30,24 @@ export namespace ExpectedExports { * service starting, and that file would indicate that it would rescan all the data. */ export type action = { - [id: string]: (options: { - effects: Effects; - input?: Record; - }) => Promise; + [id: string]: (options: { effects: Effects; input?: Record }) => Promise; }; /** * 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 = (options: { - effects: Effects; - started(onTerm: () => void): null; - }) => Promise; + export type main = (options: { effects: Effects; started(onTerm: () => void): null }) => Promise; /** * Every time a package completes an install, this function is called before the main. * Can be used to do migration like things. */ - export type init = (options: { - effects: Effects; - previousVersion: null | string; - }) => Promise; + export type init = (options: { effects: Effects; previousVersion: null | string }) => Promise; /** This will be ran during any time a package is uninstalled, for example during a update * this will be called. */ - export type uninit = (options: { - effects: Effects; - nextVersion: null | string; - }) => Promise; + export type uninit = (options: { effects: Effects; nextVersion: null | string }) => Promise; } export type TimeMs = number; export type VersionString = string; @@ -88,11 +61,7 @@ export type ConfigRes = { /** Used to reach out from the pure js runtime */ export type Effects = { /** Usable when not sandboxed */ - writeFile(input: { - path: string; - volumeId: string; - toWrite: string; - }): Promise; + writeFile(input: { path: string; volumeId: string; toWrite: string }): Promise; readFile(input: { volumeId: string; path: string }): Promise; metadata(input: { volumeId: string; path: string }): Promise; /** Create a directory. Usable when not sandboxed */ @@ -104,23 +73,13 @@ export type Effects = { removeFile(input: { volumeId: string; path: string }): Promise; /** Write a json file into an object. Usable when not sandboxed */ - writeJsonFile(input: { - volumeId: string; - path: string; - toWrite: Record; - }): Promise; + writeJsonFile(input: { volumeId: string; path: string; toWrite: Record }): Promise; /** Read a json file into an object */ - readJsonFile(input: { - volumeId: string; - path: string; - }): Promise>; + readJsonFile(input: { volumeId: string; path: string }): Promise>; - runCommand(input: { - command: string; - args?: string[]; - timeoutMillis?: number; - }): Promise; + shell(command: string, options?: { timeoutMillis?: number | null }): Promise; + runCommand(input: { command: string; args?: string[]; timeoutMillis?: number }): Promise; runDaemon(input: { command: string; args?: string[] }): { wait(): Promise; term(): Promise; @@ -150,17 +109,9 @@ export type Effects = { /** Check that a file exists or not */ exists(input: { volumeId: string; path: string }): Promise; /** Declaring that we are opening a interface on some protocal for local network */ - bindLocal(options: { - internalPort: number; - name: string; - externalPort: number; - }): Promise; + bindLocal(options: { internalPort: number; name: string; externalPort: number }): Promise; /** Declaring that we are opening a interface on some protocal for tor network */ - bindTor(options: { - internalPort: number; - name: string; - externalPort: number; - }): Promise; + bindTor(options: { internalPort: number; name: string; externalPort: number }): Promise; /** Similar to the fetch api via the mdn, this is simplified but the point is * to get something from some website, and return the response. @@ -208,22 +159,13 @@ export type Effects = { }): Promise; /** Get the address for another service for local internet*/ - getServiceLocalAddress(options: { - packageId: string; - interfaceName: string; - }): Promise; + getServiceLocalAddress(options: { packageId: string; interfaceName: string }): Promise; /** Get the address for another service for tor interfaces */ - getServiceTorAddress(options: { - packageId: string; - interfaceName: string; - }): Promise; + getServiceTorAddress(options: { packageId: string; interfaceName: string }): Promise; /** * Get the port address for another service */ - getServicePortForward(options: { - packageId: string; - internalPort: number; - }): Promise; + getServicePortForward(options: { packageId: string; internalPort: number }): Promise; /** When we want to create a link in the front end interfaces, and example is * exposing a url to view a web service @@ -279,10 +221,7 @@ export type Effects = { * * @returns PEM encoded fullchain (ecdsa) */ - getSslCertificate: ( - packageId: string, - algorithm?: "ecdsa" | "ed25519" - ) => [string, string, string]; + getSslCertificate: (packageId: string, algorithm?: "ecdsa" | "ed25519") => [string, string, string]; /** * @returns PEM encoded ssl key (ecdsa) */ @@ -410,6 +349,4 @@ export type Dependencies = { }; }; -export type DeepPartial = T extends {} - ? { [P in keyof T]?: DeepPartial } - : T; +export type DeepPartial = T extends {} ? { [P in keyof T]?: DeepPartial } : T;