config.KuitoConfig — Kuito Dokumentation

Verwendung

Fail builds on a fallback

tsx

import type { KuitoConfig } from 'kuito/config';

export default {
  name: 'MyApp',
  ios: { bundleIdentifier: 'com.example.myapp' },
  android: { applicationId: 'com.example.myapp' },
  strict: true,
} satisfies KuitoConfig;

Typdeklaration

export interface KuitoConfig extends Settings {
  environments?: Record<string, Environment>;
  /**
   * The database's migrations, oldest first. Each applies once, in order, when
   * the app first opens the database; append new ones and never edit one that
   * shipped. Every environment shares them.
   */
  migrations?: Migration[];
}

Mitglieder 20

Name	Typ	Erforderlich	Beschreibung
`environments`	`Record<string, Environment>`	Nein	—
`migrations`	`Migration[]`	Nein	The database's migrations, oldest first. Each applies once, in order, when the app first opens the database; append new ones and never edit one that shipped. Every environment shares them.
`name`	`string`	Ja	Shown under the app icon.
`version`	`string`	Nein	What users see: up to three numbers, like 1.2.0. Defaults to 1.0.0.
`buildNumber`	`number`	Nein	What the stores order builds by; raise it for every upload. Defaults to 1.
`icon`	`string`	Nein	A square PNG of at least 1024×1024, relative to kuito.config.ts.
`orientation`	`Orientation`	Nein	The orientations the app runs in. `default` follows the device.
`colorScheme`	`ColorScheme`	Nein	`light` or `dark` ignores the system setting, as CSS's `color-scheme`.
`backgroundColor`	`string`	Nein	The root window's color, behind the app, like `#1E88E5`.
`statusBar`	`{ style?: StatusBarStyle; hidden?: boolean;}`	Nein	The status bar at launch; `SystemBars` changes it at run time.
`urlSchemes`	`string[]`	Nein	Schemes that open the app, like `myapp` for `myapp://show/42` (docs/linking.md).
`linkDomains`	`string[]`	Nein	Web domains whose https links open the app, like `example.com`: universal links on iOS, verified app links on Android (docs/linking.md).
`ios`	`{ bundleIdentifier: string; icon?: { light?: string; dark?: string; tinted?: string; }; supportsTablet?: boolean; requiresFullScreen?: boolean; deploymentTarget?: string; teamId?: string; associatedDomains?: string[]; pushEnvironment?: PushEnvironment; backgroundModes?: IOSBackgroundMode[]; infoPlist?: PlistDictionary; entitlements?: PlistDictionary;}`	Ja	—
`android`	`{ applicationId: string; adaptiveIcon?: { foreground?: string; background?: string; monochrome?: string; }; softInputMode?: SoftInputMode; minSdk?: number; signing?: { keystore?: string; keyAlias?: string; }; manifest?: AndroidManifestSettings; theme?: Record<string, string>;}`	Ja	—
`permissions`	`KuitoPermissions`	Nein	The permissions the app asks for (docs/permissions.md); none when absent.
`backgroundTasks`	`string[]`	Nein	Names of the tasks the OS may run in the background (docs/background-tasks.md). An environment's list replaces this one.
`fonts`	`(string \| KuitoFont)[]`	Nein	.ttf and .otf files `fontFamily` takes (docs/fonts.md), relative to kuito.config.ts. Each file's family, weight and style are read from it; an object sets them instead.
`splash`	`KuitoSplash`	Nein	The launch screen, and the view the app hands off from (docs/splash.md).
`updates`	`{ url: string; publicKey: string;}`	Nein	Over-the-air updates of a release build (docs/updates.md): where its shell looks for them, and the key their signatures are checked with. Absent, a release build takes none.
`strict`	`boolean`	Nein	Code that reads or moves what lives on the UI thread but has to run on the JS thread fails the build, instead of showing in the placement report (docs/placement.md). Defaults to false.

statusBar — verschachtelte Felder

statusBar Felder

Name	Typ	Erforderlich	Beschreibung
`style`	`StatusBarStyle`	Nein	The color of its content: `light` for dark backgrounds. `auto` follows the color scheme.
`hidden`	`boolean`	Nein	—

ios — verschachtelte Felder

ios Felder

Name	Typ	Erforderlich	Beschreibung
`bundleIdentifier`	`string`	Ja	—
`icon`	`{ light?: string; dark?: string; tinted?: string;}`	Nein	`light` replaces `icon` on iOS; `dark` and `tinted` are its iOS 18 appearances.
`supportsTablet`	`boolean`	Nein	Runs on iPad too. Defaults to true.
`requiresFullScreen`	`boolean`	Nein	Opts out of iPad multitasking (`UIRequiresFullScreen`).
`deploymentTarget`	`string`	Nein	The oldest iOS the app runs on, 16.0 or later.
`teamId`	`string`	Nein	The Apple Developer Team ID an iPhone build signs with, like `A1B2C3D4E5` (docs/cli.md#release-builds). Simulator builds need none.
`associatedDomains`	`string[]`	Nein	Like `applinks:example.com`, for universal links.
`pushEnvironment`	`"development" \| "production"`	Nein	The APNs environment remote push uses: the `aps-environment` entitlement (docs/notifications.md#remote-push). Absent, the app receives no push.
`backgroundModes`	`("location" \| "audio" \| "voip" \| "fetch" \| "remote-notification" \| "processing" \| "external-accessory" \| "bluetooth-central" \| "bluetooth-peripheral" \| "nearby-interaction" \| "push-to-talk")[]`	Nein	—
`infoPlist`	`PlistDictionary`	Nein	Merged into the generated Info.plist.
`entitlements`	`PlistDictionary`	Nein	Merged into the generated entitlements.

icon — verschachtelte Felder

icon Felder

Name	Typ	Erforderlich	Beschreibung
`light`	`string`	Nein	—
`dark`	`string`	Nein	—
`tinted`	`string`	Nein	—

android — verschachtelte Felder

android Felder

Name	Typ	Erforderlich	Beschreibung
`applicationId`	`string`	Ja	—
`adaptiveIcon`	`{ foreground?: string; background?: string; monochrome?: string;}`	Nein	Layers of the 108dp adaptive icon; without one, `icon` fills its visible 72dp.
`softInputMode`	`SoftInputMode`	Nein	What the window does for the keyboard. Defaults to `resize` (docs/apps.md).
`minSdk`	`number`	Nein	The oldest Android API level the app runs on, 26 or later.
`signing`	`{ keystore?: string; keyAlias?: string;}`	Nein	The upload key a release build signs with (docs/cli.md#signing): a keystore relative to kuito.config.ts and its alias. Its passwords come from the environment only.
`manifest`	`AndroidManifestSettings`	Nein	Additions to the generated AndroidManifest.xml, as data.
`theme`	`Record<string, string>`	Nein	Items of the app's theme, `AppTheme`, by name.

adaptiveIcon — verschachtelte Felder

adaptiveIcon Felder

Name	Typ	Erforderlich	Beschreibung
`foreground`	`string`	Nein	—
`background`	`string`	Nein	A color like `#1E88E5`, or an image.
`monochrome`	`string`	Nein	The single-color layer of Android 13's themed icons.

signing — verschachtelte Felder

signing Felder

Name	Typ	Erforderlich	Beschreibung
`keystore`	`string`	Nein	—
`keyAlias`	`string`	Nein	—

updates — verschachtelte Felder

updates Felder

Name	Typ	Erforderlich	Beschreibung
`url`	`string`	Ja	An https URL the output of `kuito update build` is uploaded to.
`publicKey`	`string`	Ja	The public key `kuito update key` printed; its private half never goes here.

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.