contentful-management/dist/typings/entities/app-definition.d.ts

import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest, Link } from '../common-types';
import type { ContentfulAppDefinitionAPI } from '../create-app-definition-api';
import type { SetOptional, Except } from 'type-fest';
import type { FieldType } from './field-type';
import type { InstallationParameterType, ParameterDefinition } from './widget-parameters';
import type { AppInstallationProps } from './app-installation';
import type { EnvironmentProps } from './environment';
export interface NavigationItem {
    name: string;
    path: string;
}
type LocationType = 'app-config' | 'entry-sidebar' | 'entry-editor' | 'dialog' | 'page' | 'home';
export interface SimpleLocation {
    location: LocationType;
}
export interface EntryFieldLocation {
    location: 'entry-field';
    fieldTypes: FieldType[];
}
export interface PageLocation {
    location: 'page';
    navigationItem?: NavigationItem;
}
export type AppLocation = SimpleLocation | EntryFieldLocation | PageLocation;
export type AppDefinitionProps = {
    /**
     * System metadata
     */
    sys: BasicMetaSysProps & {
        organization: SysLink;
        shared: boolean;
    };
    /**
     * App name
     */
    name: string;
    /**
     * URL where the root HTML document of the app can be found
     */
    src?: string;
    /**
     * Link to an AppBundle
     */
    bundle?: Link<'AppBundle'>;
    /**
     * Locations where the app can be installed
     */
    locations?: AppLocation[];
    /**
     * Instance parameter definitions
     */
    parameters?: {
        instance?: ParameterDefinition[];
        installation?: ParameterDefinition<InstallationParameterType>[];
    };
};
export type CreateAppDefinitionProps = SetOptional<Except<AppDefinitionProps, 'sys' | 'bundle'>, 'src' | 'locations'>;
export type AppDefinition = ContentfulAppDefinitionAPI & AppDefinitionProps & DefaultElements<AppDefinitionProps>;
export type AppInstallationsForOrganizationProps = {
    sys: {
        type: 'Array';
    };
    items: AppInstallationProps[];
    includes: {
        Environment: EnvironmentProps[];
    };
};
/**
 * @private
 * @param makeRequest - function to make requests via an adapter
 * @param data - Raw App Definition data
 * @return Wrapped App Definition data
 */
export declare function wrapAppDefinition(makeRequest: MakeRequest, data: AppDefinitionProps): AppDefinition;
/**
 * @private
 * @param makeRequest - function to make requests via an adapter
 * @param data - Raw App Definition collection data
 * @return Wrapped App Definition collection data
 */
export declare const wrapAppDefinitionCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppDefinitionProps>) => import("../common-types").Collection<AppDefinition, AppDefinitionProps>;
export {};