config.KuitoConfig — Kuito Documentation

Utilisation

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;

Déclaration du type

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[];
}

Membres 20

Nom	Type	Requis	Description
`environments`	`Record<string, Environment>`	Non	—
`migrations`	`Migration[]`	Non	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`	Oui	Shown under the app icon.
`version`	`string`	Non	What users see: up to three numbers, like 1.2.0. Defaults to 1.0.0.
`buildNumber`	`number`	Non	What the stores order builds by; raise it for every upload. Defaults to 1.
`icon`	`string`	Non	A square PNG of at least 1024×1024, relative to kuito.config.ts.
`orientation`	`Orientation`	Non	The orientations the app runs in. `default` follows the device.
`colorScheme`	`ColorScheme`	Non	`light` or `dark` ignores the system setting, as CSS's `color-scheme`.
`backgroundColor`	`string`	Non	The root window's color, behind the app, like `#1E88E5`.
`statusBar`	`{ style?: StatusBarStyle; hidden?: boolean;}`	Non	The status bar at launch; `SystemBars` changes it at run time.
`urlSchemes`	`string[]`	Non	Schemes that open the app, like `myapp` for `myapp://show/42` (docs/linking.md).
`linkDomains`	`string[]`	Non	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;}`	Oui	—
`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>;}`	Oui	—
`permissions`	`KuitoPermissions`	Non	The permissions the app asks for (docs/permissions.md); none when absent.
`backgroundTasks`	`string[]`	Non	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)[]`	Non	.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`	Non	The launch screen, and the view the app hands off from (docs/splash.md).
`updates`	`{ url: string; publicKey: string;}`	Non	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`	Non	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 — champs imbriqués

statusBar champs

Nom	Type	Requis	Description
`style`	`StatusBarStyle`	Non	The color of its content: `light` for dark backgrounds. `auto` follows the color scheme.
`hidden`	`boolean`	Non	—

ios — champs imbriqués

ios champs

Nom	Type	Requis	Description
`bundleIdentifier`	`string`	Oui	—
`icon`	`{ light?: string; dark?: string; tinted?: string;}`	Non	`light` replaces `icon` on iOS; `dark` and `tinted` are its iOS 18 appearances.
`supportsTablet`	`boolean`	Non	Runs on iPad too. Defaults to true.
`requiresFullScreen`	`boolean`	Non	Opts out of iPad multitasking (`UIRequiresFullScreen`).
`deploymentTarget`	`string`	Non	The oldest iOS the app runs on, 16.0 or later.
`teamId`	`string`	Non	The Apple Developer Team ID an iPhone build signs with, like `A1B2C3D4E5` (docs/cli.md#release-builds). Simulator builds need none.
`associatedDomains`	`string[]`	Non	Like `applinks:example.com`, for universal links.
`pushEnvironment`	`"development" \| "production"`	Non	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")[]`	Non	—
`infoPlist`	`PlistDictionary`	Non	Merged into the generated Info.plist.
`entitlements`	`PlistDictionary`	Non	Merged into the generated entitlements.

icon — champs imbriqués

icon champs

Nom	Type	Requis	Description
`light`	`string`	Non	—
`dark`	`string`	Non	—
`tinted`	`string`	Non	—

android — champs imbriqués

android champs

Nom	Type	Requis	Description
`applicationId`	`string`	Oui	—
`adaptiveIcon`	`{ foreground?: string; background?: string; monochrome?: string;}`	Non	Layers of the 108dp adaptive icon; without one, `icon` fills its visible 72dp.
`softInputMode`	`SoftInputMode`	Non	What the window does for the keyboard. Defaults to `resize` (docs/apps.md).
`minSdk`	`number`	Non	The oldest Android API level the app runs on, 26 or later.
`signing`	`{ keystore?: string; keyAlias?: string;}`	Non	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`	Non	Additions to the generated AndroidManifest.xml, as data.
`theme`	`Record<string, string>`	Non	Items of the app's theme, `AppTheme`, by name.

adaptiveIcon — champs imbriqués

adaptiveIcon champs

Nom	Type	Requis	Description
`foreground`	`string`	Non	—
`background`	`string`	Non	A color like `#1E88E5`, or an image.
`monochrome`	`string`	Non	The single-color layer of Android 13's themed icons.

signing — champs imbriqués

signing champs

Nom	Type	Requis	Description
`keystore`	`string`	Non	—
`keyAlias`	`string`	Non	—

updates — champs imbriqués

updates champs

Nom	Type	Requis	Description
`url`	`string`	Oui	An https URL the output of `kuito update build` is uploaded to.
`publicKey`	`string`	Oui	The public key `kuito update key` printed; its private half never goes here.

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.