@expo/config/build/Config.types.d.ts

A library for interacting with the app.json

import { ModConfig } from '@expo/config-plugins';
import { ExpoConfig } from '@expo/config-types';
export { ExpoConfig };
export type PackageJSONConfig = {
    dependencies?: Record<string, string>;
    [key: string]: any;
};
export interface ProjectConfig {
    /**
     * Fully evaluated Expo config with default values injected.
     */
    exp: ExpoConfig;
    /**
     * Dynamic config for processing native files during the generation process.
     */
    mods?: ModConfig | null;
    /**
     * Project package.json object with default values injected.
     */
    pkg: PackageJSONConfig;
    /**
     * Unaltered static config (app.config.json, app.json, or custom json config).
     * For legacy, an empty object will be returned even if no static config exists.
     */
    rootConfig: AppJSONConfig;
    /**
     * Path to the static json config file if it exists.
     * If a project has an app.config.js and an app.json then app.json will be returned.
     * If a project has an app.config.json and an app.json then app.config.json will be returned.
     * Returns null if no static config file exists.
     */
    staticConfigPath: string | null;
    /**
     * Path to an app.config.js or app.config.ts.
     * Returns null if no dynamic config file exists.
     */
    dynamicConfigPath: string | null;
    /**
     * Returns the type of the value exported from the dynamic config.
     * This can be used to determine if the dynamic config is potentially extending a static config when (v === 'function').
     * Returns null if no dynamic config file exists.
     */
    dynamicConfigObjectType: string | null;
    /**
     * Returns true if both a static and dynamic config are present, and the dynamic config is applied on top of the static.
     * This is only used for expo-doctor diagnostic warnings. This flag may be true even in cases where all static config values are used.
     * It only checks against a typical pattern for layering static and dynamic config, e.g.,:
     * module.exports = ({ config }) => {
        return {
          ...config,
          name: 'name overridden by dynamic config',
        };
      };
     */
    hasUnusedStaticConfig: boolean;
}
export type AppJSONConfig = {
    expo: ExpoConfig;
    [key: string]: any;
};
export type BareAppConfig = {
    name: string;
    [key: string]: any;
};
export type HookArguments = {
    config: any;
    url: any;
    exp: ExpoConfig;
    iosBundle: string | Uint8Array;
    iosSourceMap: string | null;
    iosManifest: any;
    iosManifestUrl: string;
    androidBundle: string | Uint8Array;
    androidSourceMap: string | null;
    androidManifest: any;
    androidManifestUrl: string;
    projectRoot: string;
    log: (msg: any) => void;
};
export type ExpoGoConfig = {
    mainModuleName: string;
    debuggerHost: string;
    developer: {
        tool: string | null;
        projectRoot?: string;
    };
    packagerOpts: {
        [key: string]: any;
    };
};
export type EASConfig = {
    projectId?: string;
};
export type ClientScopingConfig = {
    scopeKey?: string;
};
export interface ExpoUpdatesManifestAsset {
    url: string;
    key: string;
    contentType: string;
    hash?: string;
}
export interface ExpoUpdatesManifest {
    id: string;
    createdAt: string;
    runtimeVersion: string;
    launchAsset: ExpoUpdatesManifestAsset;
    assets: ExpoUpdatesManifestAsset[];
    metadata: {
        [key: string]: string;
    };
    extra: ClientScopingConfig & {
        expoClient?: ExpoConfig & {
            /**
             * Only present during development using @expo/cli.
             */
            hostUri?: string;
        };
        expoGo?: ExpoGoConfig;
        eas?: EASConfig;
    };
}
export type Hook = {
    file: string;
    config: any;
};
export type HookType = 'postPublish' | 'postExport';
export declare enum ProjectPrivacy {
    PUBLIC = "public",
    UNLISTED = "unlisted"
}
export type Platform = 'android' | 'ios' | 'web';
export type ProjectTarget = 'managed' | 'bare';
export type ConfigErrorCode = 'NO_APP_JSON' | 'NOT_OBJECT' | 'NO_EXPO' | 'MODULE_NOT_FOUND' | 'DEPRECATED' | 'INVALID_MODE' | 'INVALID_FORMAT' | 'INVALID_PLUGIN' | 'INVALID_CONFIG' | 'ENTRY_NOT_FOUND';
export type ConfigContext = {
    projectRoot: string;
    /**
     * The static config path either app.json, app.config.json, or a custom user-defined config.
     */
    staticConfigPath: string | null;
    packageJsonPath: string | null;
    config: Partial<ExpoConfig>;
};
export type GetConfigOptions = {
    isPublicConfig?: boolean;
    /**
     * Should the config `mods` be preserved in the config? Used for compiling mods in the eject command.
     *
     * @default false
     */
    isModdedConfig?: boolean;
    skipSDKVersionRequirement?: boolean;
    /**
     * Dangerously skip resolving plugins.
     */
    skipPlugins?: boolean;
    strict?: boolean;
};
export type WriteConfigOptions = {
    dryRun?: boolean;
};
export type ConfigFilePaths = {
    staticConfigPath: string | null;
    dynamicConfigPath: string | null;
};