Dev workflow helpers for setup, reset, and database management.
Composable functions that consumer projects (tx, visiones, etc.) use in their
scripts/dev_setup.ts, scripts/dev_reset.ts, etc. All functions accept narrow
*Deps interfaces from runtime/deps.ts — pass a RuntimeDeps instance
created by create_deno_runtime().
17 declarations
(deps: CommandDeps, db_name: string, options?: CreateDatabaseOptions | undefined): Promise<CommandResult> Create a PostgreSQL database if createdb is available.
depscommand execution capability
db_namedatabase name to create
stringoptions?logger
CreateDatabaseOptions | undefinedPromise<CommandResult> the command result
CreateDatabaseOptions Options for create_database.
logSetupLogger Default logger using bracket format.
(deps: CommandDeps): Promise<string> Generate a random base64 key using openssl.
depscommand execution capability
Promise<string> a random 32-byte base64-encoded key
(url: string): string | null Extract the database name from a PostgreSQL URL.
urlstringstring | null the database name, or null if the URL is invalid or has no path
(deps: FsReadDeps, env_path: string, name: string): Promise<string | undefined> Read a single env var from a dotenv-style file.
depsfile read capability
env_pathpath to the .env file
stringnamethe variable name to read
stringPromise<string | undefined> the value, or undefined if the file or variable doesn't exist
(deps: FsReadDeps & FsWriteDeps & FsRemoveDeps & CommandDeps & EnvDeps, app_name: string, options?: SetupBootstrapTokenOptions | undefined): Promise<...> Remove an existing bootstrap token and create a new one.
depsfile, command, env, and remove capabilities
FsReadDeps & FsWriteDeps & FsRemoveDeps & CommandDeps & EnvDepsapp_nameapplication name
stringoptions?state_dir override, permissions, logger
SetupBootstrapTokenOptions | undefinedPromise<SetupTokenResult> result from creating the new token
(deps: CommandDeps & FsReadDeps & FsRemoveDeps, database_url: string, options?: ResetDatabaseOptions | undefined): Promise<...> Reset a database to a clean slate.
For PostgreSQL: drops and recreates the database.
For pglite: removes the data directory if pglite_data_dir is provided.
For empty/missing URLs: skips.
depscommand and file capabilities
CommandDeps & FsReadDeps & FsRemoveDepsdatabase_urlthe DATABASE_URL value
stringoptions?pglite_data_dir, logger
ResetDatabaseOptions | undefinedPromise<ResetDbResult> result describing what happened
ResetDatabaseOptions Options for reset_database.
pglite_data_dirDirectory to remove for file-based pglite.
stringlogResetDbResult Result of reset_database.
resetWhether the database was actually reset.
booleanskippedWhether the operation was skipped (e.g. pglite with no data dir).
booleandb_typeWhat type of database was detected.
'postgres' | 'pglite' | 'none'(deps: FsReadDeps & FsWriteDeps & CommandDeps & EnvDeps, app_name: string, options?: SetupBootstrapTokenOptions | undefined): Promise<...> Create a bootstrap token file if it doesn't exist.
The token is a one-shot secret used to create the first admin account.
Stored at ~/.{app_name}/secret_bootstrap_token by default.
depsfile, command, and env capabilities
FsReadDeps & FsWriteDeps & CommandDeps & EnvDepsapp_nameapplication name (used for default state directory)
stringoptions?state_dir override, permissions, logger
SetupBootstrapTokenOptions | undefinedPromise<SetupTokenResult> result indicating whether a token was created
(deps: FsReadDeps & FsWriteDeps & CommandDeps, env_path: string, example_path: string, options?: SetupEnvOptions | undefined): Promise<...> Create an env file from its example template, auto-generating SECRET_COOKIE_KEYS.
If the file already exists, backfills any empty values that have generators. Idempotent — safe to re-run.
depsfile read, write, and command capabilities
FsReadDeps & FsWriteDeps & CommandDepsenv_pathpath for the env file (e.g. .env.development)
stringexample_pathpath to the example template
stringoptions?extra replacements, permissions, logger
SetupEnvOptions | undefinedPromise<SetupEnvResult> result indicating whether the file was created or updated
SetupBootstrapTokenOptions Options for setup_bootstrap_token.
state_dirState directory override. Defaults to ~/.{app_name}.
stringset_permissionsOptional callback to set file/directory permissions.
(path: string, mode: number) => Promise<void>logSetupEnvOptions Options for setup_env_file.
replacementsExtra env var replacements beyond the default SECRET_COOKIE_KEYS.
Keys are env var names, values are async generators.
Replaces ^KEY=$ (empty value) patterns in the env file.
Record<string, () => Promise<string>>set_permissionsOptional callback to set file permissions (e.g. Deno.chmod).
(path: string, mode: number) => Promise<void>logSetupEnvResult Result of setup_env_file.
createdWhether a new file was created (vs updating existing).
booleanupdatedWhether any values were generated/replaced.
booleanpathThe env file path.
stringSetupLogger Optional logger for setup helpers.
Functions that accept a logger use it for status messages. When omitted, a default bracket-format logger writes to console.
ok(msg: string) => voidskip(msg: string) => voiderror(msg: string) => voidSetupTokenResult Result of setup_bootstrap_token.
createdWhether a new token was created (false if already existed).
booleantoken_pathThe token file path.
string