App config reference - docs

config.ts

Located at src/server/config.ts.

import type { AppConfig } from '@synthetiq/app-framework/server';

export const APP_CONFIG = {
  app: {
    displayName: 'My App',
    description: 'What the app does',
    category: 'Analytics',
  },
  settings: [],
} as const satisfies AppConfig;

App metadata

Field	Description
`displayName`	Human-readable app name, title-cased
`description`	Short description
`category`	App category for organization in the Synthetiq console

Setting types

Type	Description
`text`	Free-form text input
`password`	Masked text input
`url`	URL input with validation
`select`	Dropdown with predefined options
`boolean`	Toggle switch

Setting definition

{
  key: 'myKey',
  description: 'What this setting controls',
  type: 'select',
  required: false,
  defaultValue: 'default',
  options: JSON.stringify([
    { value: 'a', label: 'Option A' },
    { value: 'b', label: 'Option B' },
  ]),
}

Accessing settings

Server-side only, via ctx.appSettings:

const value = ctx.appSettings.myKey || 'default';

To expose settings to the frontend, create a tRPC procedure that returns the needed values.

⌘I