config.KuitoConfig — Kuito Documentação

Utilização

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;

Declaração do tipo

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

Membros 20

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

statusBar campos

Nome	Tipo	Obrigatório	Descrição
`style`	`StatusBarStyle`	Não	The color of its content: `light` for dark backgrounds. `auto` follows the color scheme.
`hidden`	`boolean`	Não	—

ios — campos aninhados

ios campos

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

icon — campos aninhados

icon campos

Nome	Tipo	Obrigatório	Descrição
`light`	`string`	Não	—
`dark`	`string`	Não	—
`tinted`	`string`	Não	—

android — campos aninhados

android campos

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

adaptiveIcon — campos aninhados

adaptiveIcon campos

Nome	Tipo	Obrigatório	Descrição
`foreground`	`string`	Não	—
`background`	`string`	Não	A color like `#1E88E5`, or an image.
`monochrome`	`string`	Não	The single-color layer of Android 13's themed icons.

signing — campos aninhados

signing campos

Nome	Tipo	Obrigatório	Descrição
`keystore`	`string`	Não	—
`keyAlias`	`string`	Não	—

updates — campos aninhados

updates campos

Nome	Tipo	Obrigatório	Descrição
`url`	`string`	Sim	An https URL the output of `kuito update build` is uploaded to.
`publicKey`	`string`	Sim	The public key `kuito update key` printed; its private half never goes here.

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.