MacPro
2935 lines
147 KiB
TypeScript
2935 lines
147 KiB
TypeScript
import * as actions from '../../base/lib/actions';
|
|
import { InputSpec } from '../../base/lib/actions/input/builder/inputSpec';
|
|
import { List } from '../../base/lib/actions/input/builder/list';
|
|
import { Value } from '../../base/lib/actions/input/builder/value';
|
|
import { Variants } from '../../base/lib/actions/input/builder/variants';
|
|
import { Action, ActionInfo, Actions, MaybeFn, Run } from '../../base/lib/actions/setupActions';
|
|
import { CheckDependencies } from '../../base/lib/dependencies/dependencies';
|
|
import { setupInit, setupOnInit, setupOnUninit, setupUninit } from '../../base/lib/inits';
|
|
import { MultiHost, Scheme } from '../../base/lib/interfaces/Host';
|
|
import { ServiceInterfaceBuilder } from '../../base/lib/interfaces/ServiceInterfaceBuilder';
|
|
import * as T from '../../base/lib/types';
|
|
import { Effects, ServiceInterfaceType } from '../../base/lib/types';
|
|
import { GetContainerIp } from '../../base/lib/util/GetContainerIp';
|
|
import { GetStatus } from '../../base/lib/util/GetStatus';
|
|
import { getOwnServiceInterface } from '../../base/lib/util/getServiceInterface';
|
|
import { getOwnServiceInterfaces } from '../../base/lib/util/getServiceInterfaces';
|
|
import * as patterns from '../../base/lib/util/patterns';
|
|
import { Backups } from './backup/Backups';
|
|
import { SetupBackupsParams } from './backup/setupBackups';
|
|
import { checkPortListening } from './health/checkFns/checkPortListening';
|
|
import { Daemon, Daemons } from './mainFn/Daemons';
|
|
import { Mounts } from './mainFn/Mounts';
|
|
import { changeOnFirstSuccess, cooldownTrigger } from './trigger';
|
|
import { GetOutboundGateway, GetSslCertificate, GetSystemSmtp, getServiceInterface, getServiceInterfaces, getServiceManifest, nullIfEmpty } from './util';
|
|
import { CommandOptions, SubContainer } from './util/SubContainer';
|
|
import { getDataVersion, setDataVersion } from './version';
|
|
/** The minimum StartOS version required by this SDK release */
|
|
export declare const OSVersion: "0.4.0-alpha.23";
|
|
type AnyNeverCond<T extends any[], Then, Else> = T extends [] ? Else : T extends [never, ...Array<any>] ? Then : T extends [any, ...infer U] ? AnyNeverCond<U, Then, Else> : never;
|
|
/**
|
|
* The top-level SDK facade for building StartOS service packages.
|
|
*
|
|
* Use `StartSdk.of()` to create an uninitialized instance, then call `.withManifest()`
|
|
* to bind it to a manifest, and finally `.build()` to obtain the full toolkit of helpers
|
|
* for actions, daemons, backups, interfaces, health checks, and more.
|
|
*
|
|
* @typeParam Manifest - The service manifest type; starts as `never` until `.withManifest()` is called.
|
|
*/
|
|
export declare class StartSdk<Manifest extends T.SDKManifest> {
|
|
readonly manifest: Manifest;
|
|
private constructor();
|
|
/**
|
|
* Create an uninitialized StartSdk instance. Call `.withManifest()` next.
|
|
* @returns A new StartSdk with no manifest bound.
|
|
*/
|
|
static of(): StartSdk<never>;
|
|
/**
|
|
* Bind a manifest to the SDK, producing a typed SDK instance.
|
|
* @param manifest - The service manifest definition
|
|
* @returns A new StartSdk instance parameterized by the given manifest type
|
|
*/
|
|
withManifest<Manifest extends T.SDKManifest = never>(manifest: Manifest): StartSdk<Manifest>;
|
|
private ifPluginEnabled;
|
|
/**
|
|
* Finalize the SDK and return the full set of helpers for building a StartOS service.
|
|
*
|
|
* This method is only callable after `.withManifest()` has been called (enforced at the type level).
|
|
*
|
|
* @param isReady - Type-level gate; resolves to `true` only when a manifest is bound.
|
|
* @returns An object containing all SDK utilities: actions, daemons, backups, interfaces, health checks, volumes, triggers, and more.
|
|
*/
|
|
build(isReady: AnyNeverCond<[Manifest], 'Build not ready', true>): {
|
|
/** Persist the current data version to the StartOS effect system */
|
|
setDataVersion: typeof setDataVersion;
|
|
/** Retrieve the current data version from the StartOS effect system */
|
|
getDataVersion: typeof getDataVersion;
|
|
action: {
|
|
/** Execute an action by its ID, optionally providing input */
|
|
run: <Input extends Record<string, unknown>>(options: {
|
|
effects: T.Effects;
|
|
actionId: T.ActionId;
|
|
input?: actions.RunActionInput<Input>;
|
|
}) => Promise<T.ActionResult | null>;
|
|
/** Create a task notification for a specific package's action */
|
|
createTask: <T extends ActionInfo<T.ActionId, any>>(effects: T.Effects, packageId: T.PackageId, action: T, severity: T.TaskSeverity, options?: actions.TaskOptions<T>) => Promise<null>;
|
|
/** Create a task notification for this service's own action (uses manifest.id automatically) */
|
|
createOwnTask: <T extends ActionInfo<T.ActionId, any>>(effects: T.Effects, action: T, severity: T.TaskSeverity, options?: actions.TaskOptions<T>) => Promise<null>;
|
|
/**
|
|
* Clear one or more task notifications by their replay IDs
|
|
* @param effects - The effects context
|
|
* @param replayIds - One or more replay IDs of the tasks to clear
|
|
*/
|
|
clearTask: (effects: T.Effects, ...replayIds: string[]) => Promise<null>;
|
|
};
|
|
/**
|
|
* Check whether the specified (or all) dependencies are satisfied.
|
|
* @param effects - The effects context
|
|
* @param packageIds - Optional subset of dependency IDs to check; defaults to all
|
|
* @returns An object describing which dependencies are satisfied and which are not
|
|
*/
|
|
checkDependencies: <DependencyId extends keyof Manifest["dependencies"] & T.PackageId = keyof Manifest["dependencies"] & T.PackageId>(effects: Effects, packageIds?: DependencyId[]) => Promise<CheckDependencies<DependencyId>>;
|
|
serviceInterface: {
|
|
/** Retrieve a single service interface belonging to this package by its ID */
|
|
getOwn: typeof getOwnServiceInterface;
|
|
/** Retrieve a single service interface from any package */
|
|
get: typeof getServiceInterface;
|
|
/** Retrieve all service interfaces belonging to this package */
|
|
getAllOwn: typeof getOwnServiceInterfaces;
|
|
/** Retrieve all service interfaces, optionally filtering by package */
|
|
getAll: typeof getServiceInterfaces;
|
|
};
|
|
/**
|
|
* Get the container IP address with reactive subscription support.
|
|
*
|
|
* Returns an object with multiple read strategies: `const()` for a value
|
|
* that retries on change, `once()` for a single read, `watch()` for an async
|
|
* generator, `onChange()` for a callback, and `waitFor()` to block until a predicate is met.
|
|
*
|
|
* @param effects - The effects context
|
|
* @param options - Optional filtering options (e.g. `containerId`)
|
|
*/
|
|
getContainerIp: (effects: T.Effects, options?: Omit<Parameters<T.Effects["getContainerIp"]>[0], "callback">) => GetContainerIp;
|
|
/**
|
|
* Get the service's current status with reactive subscription support.
|
|
*
|
|
* Returns an object with multiple read strategies: `const()` for a value
|
|
* that retries on change, `once()` for a single read, `watch()` for an async
|
|
* generator, `onChange()` for a callback, and `waitFor()` to block until a predicate is met.
|
|
*
|
|
* @param effects - The effects context
|
|
* @param options - Optional filtering options (e.g. `packageId`)
|
|
*/
|
|
getStatus: (effects: T.Effects, options?: Omit<Parameters<T.Effects["getStatus"]>[0], "callback">) => GetStatus;
|
|
MultiHost: {
|
|
/**
|
|
* Create a new MultiHost instance for binding ports and exporting interfaces.
|
|
* @param effects - The effects context
|
|
* @param id - A unique identifier for this multi-host group
|
|
*/
|
|
of: (effects: Effects, id: string) => MultiHost;
|
|
};
|
|
/**
|
|
* Return `null` if the given string is empty, otherwise return the string unchanged.
|
|
* Useful for converting empty user input into explicit null values.
|
|
*/
|
|
nullIfEmpty: typeof nullIfEmpty;
|
|
/**
|
|
* Indicate that a daemon should use the container image's configured entrypoint.
|
|
* @param overrideCmd - Optional command arguments to append after the entrypoint
|
|
*/
|
|
useEntrypoint: (overrideCmd?: string[]) => T.UseEntrypoint;
|
|
/**
|
|
* @description Use this class to create an Action. By convention, each Action should receive its own file.
|
|
*
|
|
*/
|
|
Action: {
|
|
/**
|
|
* @description Use this function to create an action that accepts form input
|
|
* @param id - a unique ID for this action
|
|
* @param metadata - information describing the action and its availability
|
|
* @param inputSpec - define the form input using the InputSpec and Value classes
|
|
* @param prefillFn - optionally fetch data from the file system to pre-fill the input form. Must returns a deep partial of the input spec
|
|
* @param executionFn - execute the action. Optionally return data for the user to view. Must be in the structure of an ActionResult, version "1"
|
|
* @example
|
|
* In this example, we create an action for a user to provide their name.
|
|
* We prefill the input form with their existing name from the service's yaml file.
|
|
* The new name is saved to the yaml file, and we return nothing to the user, which
|
|
* means they will receive a generic success message.
|
|
*
|
|
* ```
|
|
import { sdk } from '../sdk'
|
|
import { yamlFile } from '../file-models/config.yml'
|
|
|
|
const { InputSpec, Value } = sdk
|
|
|
|
export const inputSpec = InputSpec.of({
|
|
name: Value.text({
|
|
name: 'Name',
|
|
description:
|
|
'When you launch the Hello World UI, it will display "Hello [Name]"',
|
|
required: true,
|
|
default: 'World',
|
|
}),
|
|
})
|
|
|
|
export const setName = sdk.Action.withInput(
|
|
// id
|
|
'set-name',
|
|
|
|
// metadata
|
|
async ({ effects }) => ({
|
|
name: 'Set Name',
|
|
description: 'Set your name so Hello World can say hello to you',
|
|
warning: null,
|
|
allowedStatuses: 'any',
|
|
group: null,
|
|
visibility: 'enabled',
|
|
}),
|
|
|
|
// form input specification
|
|
inputSpec,
|
|
|
|
// optionally pre-fill the input form
|
|
async ({ effects }) => {
|
|
const name = await yamlFile.read.const(effects)?.name
|
|
return { name }
|
|
},
|
|
|
|
// the execution function
|
|
async ({ effects, input }) => yamlFile.merge(input)
|
|
)
|
|
* ```
|
|
*/
|
|
withInput: typeof Action.withInput;
|
|
/**
|
|
* @description Use this function to create an action that does not accept form input
|
|
* @param id - a unique ID for this action
|
|
* @param metadata - information describing the action and its availability
|
|
* @param executionFn - execute the action. Optionally return data for the user to view. Must be in the structure of an ActionResult, version "1"
|
|
* @example
|
|
* In this example, we create an action that returns a secret phrase for the user to see.
|
|
*
|
|
* ```
|
|
import { store } from '../file-models/store.json'
|
|
import { sdk } from '../sdk'
|
|
|
|
export const showSecretPhrase = sdk.Action.withoutInput(
|
|
// id
|
|
'show-secret-phrase',
|
|
|
|
// metadata
|
|
async ({ effects }) => ({
|
|
name: 'Show Secret Phrase',
|
|
description: 'Reveal the secret phrase for Hello World',
|
|
warning: null,
|
|
allowedStatuses: 'any',
|
|
group: null,
|
|
visibility: 'enabled',
|
|
}),
|
|
|
|
// the execution function
|
|
async ({ effects }) => ({
|
|
version: '1',
|
|
title: 'Secret Phrase',
|
|
message:
|
|
'Below is your secret phrase. Use it to gain access to extraordinary places',
|
|
result: {
|
|
type: 'single',
|
|
value: (await store.read.once())?.secretPhrase,
|
|
copyable: true,
|
|
qr: true,
|
|
masked: true,
|
|
},
|
|
}),
|
|
)
|
|
* ```
|
|
*/
|
|
withoutInput: <Id extends T.ActionId>(id: Id, metadata: MaybeFn<Omit<T.ActionMetadata, "hasInput">>, run: Run<{}>) => Action<Id, {}>;
|
|
};
|
|
inputSpecConstants: {
|
|
smtpInputSpec: Value<import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
disabled: {
|
|
name: string;
|
|
spec: InputSpec<{}, {}>;
|
|
};
|
|
system: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
customFrom: string | null;
|
|
}, {
|
|
customFrom: string | null;
|
|
}>;
|
|
};
|
|
custom: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}, {
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}>;
|
|
};
|
|
}>, import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
disabled: {
|
|
name: string;
|
|
spec: InputSpec<{}, {}>;
|
|
};
|
|
system: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
customFrom: string | null;
|
|
}, {
|
|
customFrom: string | null;
|
|
}>;
|
|
};
|
|
custom: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}, {
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}>;
|
|
};
|
|
}>, unknown>;
|
|
systemSmtpSpec: InputSpec<{
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}, {
|
|
provider: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, "other" | "gmail" | "ses" | "sendgrid" | "mailgun" | "protonmail">;
|
|
}>;
|
|
customSmtp: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
smtpProviderVariants: Variants<{
|
|
gmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
ses: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
sendgrid: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
mailgun: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
protonmail: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
other: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionRes<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}, {
|
|
host: string;
|
|
security: import("../../base/lib/actions/input/builder/variants").UnionResStaticValidatedAs<{
|
|
tls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: string;
|
|
}, {
|
|
port: string | null;
|
|
}>;
|
|
};
|
|
starttls: {
|
|
name: string;
|
|
spec: InputSpec<{
|
|
port: "587" | "25" | "2525";
|
|
}, {
|
|
port: "587" | "25" | "2525";
|
|
}>;
|
|
};
|
|
}, "starttls" | "tls">;
|
|
from: string;
|
|
username: string;
|
|
password: string | null;
|
|
}>;
|
|
};
|
|
}, unknown>;
|
|
};
|
|
/**
|
|
* @description Use this function to create a service interface.
|
|
* @param effects
|
|
* @param options
|
|
* @example
|
|
* In this example, we create a standard web UI
|
|
*
|
|
* ```
|
|
const ui = sdk.createInterface(effects, {
|
|
name: 'Web UI',
|
|
id: 'ui',
|
|
description: 'The primary web app for this service.',
|
|
type: 'ui',
|
|
masked: false,
|
|
schemeOverride: null,
|
|
username: null,
|
|
path: '',
|
|
query: {},
|
|
})
|
|
* ```
|
|
*/
|
|
createInterface: (effects: Effects, options: {
|
|
/** The human readable name of this service interface. */
|
|
name: string;
|
|
/** A unique ID for this service interface. */
|
|
id: string;
|
|
/** The human readable description. */
|
|
description: string;
|
|
/** Affects how the interface appears to the user. One of: 'ui', 'api', 'p2p'. If 'ui', the user will see an option to open the UI in a new tab */
|
|
type: ServiceInterfaceType;
|
|
/** (optional) prepends the provided username to all URLs. */
|
|
username: null | string;
|
|
/** (optional) appends the provided path to all URLs. */
|
|
path: string;
|
|
/** (optional) appends the provided query params to all URLs. */
|
|
query: Record<string, string>;
|
|
/** (optional) overrides the protocol prefix provided by the bind function.
|
|
*
|
|
* @example `{ ssl: 'ftps', noSsl: 'ftp' }`
|
|
*/
|
|
schemeOverride: {
|
|
ssl: Scheme;
|
|
noSsl: Scheme;
|
|
} | null;
|
|
/** mask the url (recommended if it contains credentials such as an API key or password) */
|
|
masked: boolean;
|
|
}) => ServiceInterfaceBuilder;
|
|
/**
|
|
* Get the system SMTP configuration with reactive subscription support.
|
|
* @param effects - The effects context
|
|
*/
|
|
getSystemSmtp: <E extends Effects>(effects: E) => GetSystemSmtp;
|
|
/**
|
|
* Get the outbound network gateway address with reactive subscription support.
|
|
* @param effects - The effects context
|
|
*/
|
|
getOutboundGateway: <E extends Effects>(effects: E) => GetOutboundGateway;
|
|
/**
|
|
* Get an SSL certificate for the given hostnames with reactive subscription support.
|
|
* @param effects - The effects context
|
|
* @param hostnames - The hostnames to obtain a certificate for
|
|
* @param algorithm - Optional algorithm preference (e.g. Ed25519)
|
|
*/
|
|
getSslCertificate: <E extends Effects>(effects: E, hostnames: string[], algorithm?: T.Algorithm) => GetSslCertificate;
|
|
/** Retrieve the manifest of any installed service package by its ID */
|
|
getServiceManifest: typeof getServiceManifest;
|
|
healthCheck: {
|
|
checkPortListening: typeof checkPortListening;
|
|
checkWebUrl: (effects: Effects, url: string, { timeout, successMessage, errorMessage, }?: {
|
|
timeout?: number | undefined;
|
|
successMessage?: string | undefined;
|
|
errorMessage?: string | undefined;
|
|
}) => Promise<import("./health/checkFns").HealthCheckResult>;
|
|
runHealthScript: <Manifest_1 extends T.SDKManifest>(runCommand: string[], subcontainer: SubContainer<Manifest_1>, { timeout, errorMessage, message, }?: {
|
|
timeout?: number | undefined;
|
|
errorMessage?: string | undefined;
|
|
message?: ((res: string) => string) | undefined;
|
|
}) => Promise<import("./health/checkFns").HealthCheckResult>;
|
|
};
|
|
/** Common utility patterns (e.g. hostname regex, port validators) */
|
|
patterns: typeof patterns;
|
|
/**
|
|
* @description Use this function to list every Action offered by the service. Actions will be displayed in the provided order.
|
|
*
|
|
* By convention, each Action should receive its own file in the "actions" directory.
|
|
* @example
|
|
*
|
|
* ```
|
|
import { sdk } from '../sdk'
|
|
import { config } from './config'
|
|
import { nameToLogs } from './nameToLogs'
|
|
|
|
export const actions = sdk.Actions.of().addAction(config).addAction(nameToLogs)
|
|
* ```
|
|
*/
|
|
Actions: {
|
|
new (actions: {}): Actions<{}>;
|
|
of(): Actions<{}>;
|
|
};
|
|
/**
|
|
* @description Use this function to determine which volumes are backed up when a user creates a backup, including advanced options.
|
|
* @example
|
|
* In this example, we back up the entire "main" volume and nothing else.
|
|
*
|
|
* ```
|
|
import { sdk } from './sdk'
|
|
|
|
export const { createBackup, restoreBackup } = sdk.setupBackups(
|
|
async ({ effects }) => sdk.Backups.volumes('main'),
|
|
)
|
|
* ```
|
|
* @example
|
|
* In this example, we back up the "main" volume, but exclude hypothetical directory "excludedDir".
|
|
*
|
|
* ```
|
|
import { sdk } from './sdk'
|
|
|
|
export const { createBackup, restoreBackup } = sdk.setupBackups(async () =>
|
|
sdk.Backups.volumes('main').setOptions({
|
|
exclude: ['excludedDir'],
|
|
}),
|
|
)
|
|
* ```
|
|
*/
|
|
setupBackups: (options: SetupBackupsParams<Manifest>) => {
|
|
createBackup: T.ExpectedExports.createBackup;
|
|
restoreInit: import("../../base/lib/inits").InitScript;
|
|
};
|
|
/**
|
|
* @description Use this function to set dependency information.
|
|
* @example
|
|
* In this example, we create a dependency on Hello World >=1.0.0:0, where Hello World must be running and passing its "primary" health check.
|
|
*
|
|
* ```
|
|
export const setDependencies = sdk.setupDependencies(
|
|
async ({ effects }) => {
|
|
return {
|
|
'hello-world': {
|
|
kind: 'running',
|
|
versionRange: '>=1.0.0',
|
|
healthChecks: ['primary'],
|
|
},
|
|
}
|
|
},
|
|
)
|
|
* ```
|
|
*/
|
|
setupDependencies: (fn: (options: {
|
|
effects: T.Effects;
|
|
}) => Promise<T.CurrentDependenciesResult<Manifest>>) => (effects: T.Effects) => Promise<null>;
|
|
/**
|
|
* @description Use this function to create an InitScript that runs every time the service initializes (install, update, restore, rebuild, and server bootup)
|
|
*/
|
|
setupOnInit: typeof setupOnInit;
|
|
/**
|
|
* @description Use this function to create an UninitScript that runs every time the service uninitializes (update, uninstall, and server shutdown)
|
|
*/
|
|
setupOnUninit: typeof setupOnUninit;
|
|
/**
|
|
* @description Use this function to setup what happens when the service initializes.
|
|
*
|
|
* This happens when the server boots, or a service is installed, updated, or restored
|
|
*
|
|
* Not every init script does something on every initialization. For example, versions only does something on install or update
|
|
*
|
|
* These scripts are run in the order they are supplied
|
|
* @example
|
|
*
|
|
* ```
|
|
export const init = sdk.setupInit(
|
|
restoreInit,
|
|
versions,
|
|
setDependencies,
|
|
setInterfaces,
|
|
actions,
|
|
postInstall,
|
|
)
|
|
* ```
|
|
*/
|
|
setupInit: typeof setupInit;
|
|
/**
|
|
* @description Use this function to setup what happens when the service uninitializes.
|
|
*
|
|
* This happens when the server shuts down, or a service is uninstalled or updated
|
|
*
|
|
* Not every uninit script does something on every uninitialization. For example, versions only does something on uninstall or update
|
|
*
|
|
* These scripts are run in the order they are supplied
|
|
* @example
|
|
*
|
|
* ```
|
|
export const uninit = sdk.setupUninit(
|
|
versions,
|
|
)
|
|
* ```
|
|
*/
|
|
setupUninit: typeof setupUninit;
|
|
/**
|
|
* @description Use this function to determine how this service will be hosted and served. The function executes on service install, service update, and inputSpec save.
|
|
* @param inputSpec - The inputSpec spec of this service as exported from /inputSpec/spec.
|
|
* @param fn - an async function that returns an array of interface receipts. The function always has access to `effects`; it has access to `input` only after inputSpec save, otherwise `input` will be null.
|
|
* @example
|
|
* In this example, we create two UIs from one multi-host, and one API from another multi-host.
|
|
*
|
|
* ```
|
|
export const setInterfaces = sdk.setupInterfaces(
|
|
async ({ effects }) => {
|
|
// ** UI multi-host **
|
|
const uiMulti = sdk.MultiHost.of(effects, 'ui-multi')
|
|
const uiMultiOrigin = await uiMulti.bindPort(80, {
|
|
protocol: 'http',
|
|
})
|
|
// Primary UI
|
|
const primaryUi = sdk.createInterface(effects, {
|
|
name: 'Primary UI',
|
|
id: 'primary-ui',
|
|
description: 'The primary web app for this service.',
|
|
type: 'ui',
|
|
masked: false,
|
|
schemeOverride: null,
|
|
username: null,
|
|
path: '',
|
|
query: {},
|
|
})
|
|
// Admin UI
|
|
const adminUi = sdk.createInterface(effects, {
|
|
name: 'Admin UI',
|
|
id: 'admin-ui',
|
|
description: 'The admin web app for this service.',
|
|
type: 'ui',
|
|
masked: false,
|
|
schemeOverride: null,
|
|
username: null,
|
|
path: '/admin',
|
|
query: {},
|
|
})
|
|
// UI receipt
|
|
const uiReceipt = await uiMultiOrigin.export([primaryUi, adminUi])
|
|
|
|
// ** API multi-host **
|
|
const apiMulti = sdk.MultiHost.of(effects, 'api-multi')
|
|
const apiMultiOrigin = await apiMulti.bindPort(5959, {
|
|
protocol: 'http',
|
|
})
|
|
// API
|
|
const api = sdk.createInterface(effects, {
|
|
name: 'Admin API',
|
|
id: 'api',
|
|
description: 'The advanced API for this service.',
|
|
type: 'api',
|
|
masked: false,
|
|
schemeOverride: null,
|
|
username: null,
|
|
path: '',
|
|
query: {},
|
|
})
|
|
// API receipt
|
|
const apiReceipt = await apiMultiOrigin.export([api])
|
|
|
|
// ** Return receipts **
|
|
return [uiReceipt, apiReceipt]
|
|
},
|
|
)
|
|
* ```
|
|
*/
|
|
setupInterfaces: import("../../base/lib/interfaces/setupInterfaces").SetupServiceInterfaces;
|
|
/**
|
|
* Define the main entrypoint for the service. The provided function should
|
|
* configure and return a `Daemons` instance describing all long-running processes.
|
|
* @param fn - Async function that receives `effects` and returns a `Daemons` instance
|
|
*/
|
|
setupMain: (fn: (o: {
|
|
effects: Effects;
|
|
}) => Promise<Daemons<Manifest, any>>) => T.ExpectedExports.main;
|
|
/** Built-in trigger strategies for controlling health-check polling intervals */
|
|
trigger: {
|
|
/** Default trigger: polls at a fixed interval */
|
|
defaultTrigger: import("./trigger").Trigger;
|
|
/** Trigger with a cooldown period between checks */
|
|
cooldownTrigger: typeof cooldownTrigger;
|
|
/** Switches to a different interval after the first successful check */
|
|
changeOnFirstSuccess: typeof changeOnFirstSuccess;
|
|
/** Uses different intervals based on success vs failure results */
|
|
successFailure: (o: {
|
|
duringSuccess: import("./trigger").Trigger;
|
|
duringError: import("./trigger").Trigger;
|
|
}) => import("./trigger").Trigger;
|
|
};
|
|
Mounts: {
|
|
/**
|
|
* Create an empty Mounts builder for declaring volume, asset, dependency, and backup mounts.
|
|
* @returns A new Mounts instance with no mounts configured
|
|
*/
|
|
of: () => Mounts<Manifest, never>;
|
|
};
|
|
Backups: {
|
|
/**
|
|
* Create a Backups configuration that backs up entire volumes by name.
|
|
* @param volumeNames - Volume IDs from the manifest to include in backups
|
|
*/
|
|
ofVolumes: (...volumeNames: Manifest["volumes"][number][]) => Backups<Manifest>;
|
|
/**
|
|
* Create a Backups configuration from explicit sync path pairs.
|
|
* @param syncs - Array of `{ dataPath, backupPath }` objects
|
|
*/
|
|
ofSyncs: (...syncs: import("./backup/Backups").BackupSync<Manifest["volumes"][number]>[]) => Backups<Manifest>;
|
|
/**
|
|
* Create a Backups configuration with custom rsync options (e.g. exclude patterns).
|
|
* @param options - Partial sync options to override defaults
|
|
*/
|
|
withOptions: (options?: Partial<T.SyncOptions>) => Backups<Manifest>;
|
|
/**
|
|
* Create a Backups configuration that uses pg_dump/pg_restore instead of
|
|
* rsyncing the raw PostgreSQL data directory. Chain `.addVolume()` to include
|
|
* additional volumes in the backup.
|
|
*/
|
|
withPgDump: (config: import("./backup/Backups").PgDumpConfig<Manifest>) => Backups<Manifest>;
|
|
/**
|
|
* Create a Backups configuration that uses mysqldump/mysql instead of
|
|
* rsyncing the raw MySQL/MariaDB data directory. Chain `.addVolume()` to
|
|
* include additional volumes in the backup.
|
|
*/
|
|
withMysqlDump: (config: import("./backup/Backups").MysqlDumpConfig<Manifest>) => Backups<Manifest>;
|
|
};
|
|
InputSpec: {
|
|
/**
|
|
* @description Use this function to define the inputSpec specification that will ultimately present to the user as validated form inputs.
|
|
*
|
|
* Most form controls are supported, including text, textarea, number, toggle, select, multiselect, list, color, datetime, object (sub form), and union (conditional sub form).
|
|
* @example
|
|
* In this example, we define a inputSpec form with two value: name and makePublic.
|
|
*
|
|
* ```
|
|
import { sdk } from '../sdk'
|
|
const { InputSpec, Value } = sdk
|
|
|
|
export const inputSpecSpec = InputSpec.of({
|
|
name: Value.text({
|
|
name: 'Name',
|
|
description:
|
|
'When you launch the Hello World UI, it will display "Hello [Name]"',
|
|
required: true,
|
|
default: 'World'
|
|
}),
|
|
makePublic: Value.toggle({
|
|
name: 'Make Public',
|
|
description: 'Whether or not to expose the service to the network',
|
|
default: false,
|
|
}),
|
|
})
|
|
* ```
|
|
*/
|
|
of: <Spec extends Record<string, Value<any>>>(spec: Spec) => InputSpec<{ [K in keyof Spec]: Spec[K] extends Value<infer T extends any, any, unknown> ? T : never; }, { [K_1 in keyof Spec]: Spec[K_1] extends Value<any, infer T_1, unknown> ? T_1 : never; }>;
|
|
};
|
|
Daemon: {
|
|
/**
|
|
* Create a single Daemon that wraps a long-running process with automatic restart logic.
|
|
* Returns a curried function: call with `(effects, subcontainer, exec)`.
|
|
*/
|
|
readonly of: <C extends SubContainer<Manifest, T.Effects> | null>(effects: T.Effects, subcontainer: C, exec: import("./mainFn/Daemons").DaemonCommandType<Manifest, C>) => Daemon<Manifest, SubContainer<Manifest, T.Effects> | null>;
|
|
};
|
|
Daemons: {
|
|
/**
|
|
* Create a new Daemons builder for defining the service's daemon topology.
|
|
* Chain `.addDaemon()` calls to register each long-running process.
|
|
* @param effects - The effects context
|
|
*/
|
|
of(effects: Effects): Daemons<Manifest, never>;
|
|
};
|
|
SubContainer: {
|
|
/**
|
|
* @description Create a new SubContainer
|
|
* @param effects
|
|
* @param image - what container image to use
|
|
* @param mounts - what to mount to the subcontainer
|
|
* @param name - a name to use to refer to the subcontainer for debugging purposes
|
|
*/
|
|
of(effects: Effects, image: {
|
|
imageId: T.ImageId & keyof Manifest["images"];
|
|
sharedRun?: boolean;
|
|
}, mounts: Mounts<Manifest> | null, name: string): Promise<import("./util/SubContainer").SubContainerRc<Manifest, T.Effects>>;
|
|
/**
|
|
* @description Run a function with a temporary SubContainer
|
|
* @param effects
|
|
* @param image - what container image to use
|
|
* @param mounts - what to mount to the subcontainer
|
|
* @param name - a name to use to refer to the ephemeral subcontainer for debugging purposes
|
|
*/
|
|
withTemp<T>(effects: T.Effects, image: {
|
|
imageId: T.ImageId & keyof Manifest["images"];
|
|
sharedRun?: boolean;
|
|
}, mounts: Mounts<Manifest> | null, name: string, fn: (subContainer: SubContainer<Manifest>) => Promise<T>): Promise<T>;
|
|
};
|
|
List: typeof List;
|
|
Value: typeof Value;
|
|
Variants: typeof Variants;
|
|
plugin: {
|
|
url: Manifest extends {
|
|
plugins: "url-v0"[];
|
|
} ? {
|
|
register: (effects: T.Effects, options: {
|
|
tableAction: ActionInfo<T.ActionId, {
|
|
urlPluginMetadata: {
|
|
packageId: T.PackageId;
|
|
interfaceId: T.ServiceInterfaceId;
|
|
hostId: T.HostId;
|
|
internalPort: number;
|
|
};
|
|
}>;
|
|
}) => Promise<null>;
|
|
exportUrl: (effects: T.Effects, options: {
|
|
hostnameInfo: T.PluginHostnameInfo;
|
|
removeAction: ActionInfo<T.ActionId, {
|
|
urlPluginMetadata: T.PluginHostnameInfo & {
|
|
interfaceId: T.ServiceInterfaceId;
|
|
};
|
|
}> | null;
|
|
overflowActions: ActionInfo<T.ActionId, {
|
|
urlPluginMetadata: T.PluginHostnameInfo & {
|
|
interfaceId: T.ServiceInterfaceId;
|
|
};
|
|
}>[];
|
|
}) => Promise<null>;
|
|
setupExportedUrls: import("../../base/lib/interfaces/setupExportedUrls").SetupExportedUrls;
|
|
} : null;
|
|
};
|
|
restart: (effects: Effects) => Promise<null>;
|
|
shutdown: (effects: Effects) => Promise<null>;
|
|
setDependencies: (effects: Effects, options: {
|
|
dependencies: T.Dependencies;
|
|
}) => Promise<null>;
|
|
getDependencies: (effects: Effects) => Promise<T.DependencyRequirement[]>;
|
|
mount: (effects: Effects, options: T.MountParams) => Promise<string>;
|
|
getInstalledPackages: (effects: Effects) => Promise<string[]>;
|
|
setHealth: (effects: Effects, o: T.SetHealth) => Promise<null>;
|
|
getServicePortForward: (effects: Effects, options: {
|
|
packageId?: T.PackageId;
|
|
hostId: T.HostId;
|
|
internalPort: number;
|
|
}) => Promise<T.NetInfo>;
|
|
clearBindings: (effects: Effects, options: {
|
|
except: {
|
|
id: T.HostId;
|
|
internalPort: number;
|
|
}[];
|
|
}) => Promise<null>;
|
|
getOsIp: (effects: Effects) => Promise<string>;
|
|
getSslKey: (effects: Effects, options: {
|
|
hostnames: string[];
|
|
algorithm?: "ecdsa" | "ed25519";
|
|
}) => Promise<string>;
|
|
/** The bound service manifest */
|
|
manifest: Manifest;
|
|
/** Volume path helpers derived from the manifest volume definitions */
|
|
volumes: import("./util").Volumes<Manifest>;
|
|
};
|
|
}
|
|
/**
|
|
* Run a one-shot command inside a temporary subcontainer.
|
|
*
|
|
* Creates a subcontainer, executes the command, and destroys the subcontainer when finished.
|
|
* Throws an {@link ExitError} if the command exits with a non-zero code or signal.
|
|
*
|
|
* @param effects - The effects context
|
|
* @param image - The container image to use
|
|
* @param command - The command to execute (string array or UseEntrypoint)
|
|
* @param options - Mount and command options
|
|
* @param name - Optional human-readable name for debugging
|
|
* @returns The stdout and stderr output of the command
|
|
*/
|
|
export declare function runCommand<Manifest extends T.SDKManifest>(effects: Effects, image: {
|
|
imageId: keyof Manifest['images'] & T.ImageId;
|
|
sharedRun?: boolean;
|
|
}, command: T.CommandType, options: CommandOptions & {
|
|
mounts: Mounts<Manifest> | null;
|
|
}, name?: string): Promise<{
|
|
stdout: string | Buffer;
|
|
stderr: string | Buffer;
|
|
}>;
|
|
export {};
|