@airplane/views/dist/client/types.d.ts

A React library for building Airplane views. Views components are optimized in style and functionality to produce internal apps that are easy to build and maintain.

export type User = {
    userID: string;
    email: string;
    name: string;
    avatarURL?: string;
};
export type Group = {
    id: string;
    name: string;
};
export type UserGroup = {
    user?: User;
    group?: Group;
};
export interface EntitiesResponse {
    results: UserGroup[];
}
export interface ConstraintOption {
    label: string;
    value: ParamValue;
}
export interface TaskOption {
    slug: string;
    params?: ParamValues;
}
export type Parameter = {
    slug: string;
    name: string;
    type: "boolean" | "upload" | "date" | "datetime" | "float" | "integer" | "string" | "json";
    component?: "textarea" | "editor-sql";
    default?: ParamValue;
    constraints: {
        optional: boolean;
        validate?: string;
        options?: Array<ConstraintOption | ParamValue> | TaskOption;
        regex?: string;
    };
    desc?: string;
    hidden?: string;
    multi?: boolean;
};
export interface TaskOrRunbookReviewersResponse {
    task?: {
        name: string;
        requireExplicitPermissions: boolean;
        triggers: {
            triggerID: string;
            kind: string;
        }[];
        parameters: {
            parameters: Parameter[];
        };
    };
    runbook?: {
        name: string;
        isPrivate: boolean;
        triggers: {
            triggerID: string;
            kind: string;
        }[];
        parameters: {
            parameters: Parameter[];
        };
    };
    reviewers: {
        userID?: string;
        groupID?: string;
    }[];
}
export type View = {
    id: string;
    slug: string;
    archivedAt?: string;
    archivedBy?: string;
    name: string;
    description?: string;
    createdAt?: string;
    createdBy?: string;
    isLocal?: boolean;
};
export type TaskMetadata = {
    id: string;
    slug: string;
    isArchived?: boolean;
    isLocal?: boolean;
};
/**
 * isConstraintOptions is a user-defined type guard for checking if a variable is a list of constraint options.
 */
export declare const isConstraintOptions: (options: unknown) => options is ConstraintOption[];
/**
 * isConstraintOption is a user-defined type guard for checking if a variable is a constraint option.
 */
export declare const isConstraintOption: (o: unknown) => o is ConstraintOption;
/**
 * isTaskOption is a user-defined type guard for checking if a variable is a TaskOption.
 */
export declare const isTaskOption: (options: unknown) => options is TaskOption;
export type JSONValue = string | number | boolean | null | JSONObject | JSONArray;
export interface JSONObject {
    [key: string]: JSONValue;
}
export type JSONArray = Array<JSONValue>;
export type SingleParamValue = string | boolean | number | Template | ConfigVar | ParamList | ParamMap | JSONValue | undefined | null;
export type MultiParamValue = ParamValue[];
export type ParamValue = SingleParamValue | MultiParamValue;
export type ParamValues = Record<string, ParamValue>;
export type ParamList = Array<unknown>;
export type ParamMap = Record<string, unknown>;
/**
 * ConfigVar is a basic representation of a config variable, used for parameters.
 */
export type ConfigVar = {
    __airplaneType: "configvar";
    name: string;
};
export type Template = {
    __airplaneType: "template";
    raw: string;
};
export declare const isTemplate: (v: unknown) => v is Template;