@sap/cf-tools/out/src/types.d.ts

Cloud Foundry API tools

export declare const OK = "OK";
export declare const NEW_LINE = "\n";
export declare const CF_PAGE_SIZE: number;
export declare const DEFAULT_TARGET = "Default (no targets)";
export interface CliResult {
    stdout: string;
    stderr: string;
    error?: string;
    exitCode: number;
}
export declare enum CF_CMD_EXIT_CODE {
    OK = 0,
    ERROR = -1,
    CANCEL_REQ = -2,
    CANCELED = -3
}
export interface CancellationToken {
    isCancellationRequested: boolean;
    onCancellationRequested: any;
}
interface Progress<T> {
    report(value: T): void;
}
export interface ProgressHandler {
    progress: Progress<{
        message?: string;
        increment?: number;
    }>;
    cancelToken: CancellationToken;
}
export interface CFTarget {
    label: string;
    isCurrent: boolean;
    isDirty: boolean;
}
export interface ServiceInstanceInfo {
    label: string;
    serviceName: string;
    guid?: string;
    tags?: string[];
    alwaysShow?: boolean;
    plan_guid?: string;
    plan?: string;
    credentials?: any;
}
export interface ServiceInfo {
    label: string;
    guid: string;
    service_plans_url: string;
    description: string;
}
export interface PlanInfo {
    label: string;
    guid: string;
    description: string;
    service_offering?: {
        guid: string;
        name: string;
        description: string;
    };
}
export interface CFResource {
    guid: string;
    name: string;
    description: string;
    schemas: any;
    relationships: any;
    metadata: any;
    links: any;
}
export interface ServiceTypeInfo {
    name: string;
    plan: string;
    tag: string;
    prompt: string;
    plans?: PlanInfo[];
    serviceKeyName?: string;
    serviceKeyParam?: any;
    ups?: {
        tag?: string;
        isShow?: boolean;
    };
    allowCreate?: {
        serviceName?: string;
        plan?: string;
        tag?: string;
        name?: string;
        namePrompt?: string;
        getParams?: () => Promise<any>;
    };
}
export declare enum eFilters {
    type = "type",
    names = "names",
    guids = "guids",
    app_guids = "app_guids",
    app_names = "app_names",
    space_guids = "space_guids",
    available = "available",
    broker_catalog_ids = "broker_catalog_ids",
    service_broker_guids = "service_broker_guids",
    service_broker_names = "service_broker_names",
    service_plan_guids = "service_plan_guids",
    organization_guids = "organization_guids",
    service_plan_names = "service_plan_names",
    service_plan = "service_plan",
    service_instance_guids = "service_instance_guids",
    service_instance_names = "service_instance_names",
    service_offering_guids = "service_offering_guids",
    service_offering_names = "service_offering_names",
    label_selector = "label_selector",
    page = "page",
    per_page = "per_page",
    oder_by = "order_by",
    created_ats = "created_ats",
    updated_ats = "updated_ats",
    status = "status",
    include = "include"
}
export declare enum eOperation {
    gte = "gte",
    lte = "lte",
    lt = "lt",
    gt = "gt",
    not = "not",
    fields = "fields"
}
export interface IServiceFilters {
    key: eFilters;
    value: string;
    op?: eOperation;
}
export declare enum eOrderDirection {
    asc = 0,
    desc = 1
}
export declare enum eServiceTypes {
    managed = "managed",
    user_provided = "user-provided"
}
export interface IServiceQuery {
    filters?: IServiceFilters[];
    per_page?: number;
    page?: number;
    order_by?: eOrderDirection;
}
export interface ServiceBinding {
    env: string;
    id: string;
    type: string;
    version: string;
}
export interface UAAInfo {
    apiurl: string;
    clientid: string;
    clientsecret: string;
    identityzone: string;
    identityzoneid: string;
    sburl: string;
    tenantid: string;
    tenantmode: string;
    uaadomain: string;
    url: string;
    verificationkey: string;
    xsappname: string;
}
export interface ServiceKey {
    binding: ServiceBinding;
    catalogs: any;
    endpoints: any;
    preserve_host_header: boolean;
    "sap.cloud.service": string;
    systemid: string;
    uaa: UAAInfo;
    url: string;
}
export interface Api {
    "api endpoint": string;
    "api version": string;
}
export interface ITarget extends Api {
    user: string;
    org?: string;
    space?: string;
}
export interface UpsTypeInfo {
    instanceName: string;
    space_guid?: string;
    syslog_drain_url?: string;
    credentials?: unknown;
    route_service_url?: string;
    tags?: string[];
}
interface LoginOptions {
    endpoint: string;
    origin?: string;
}
export interface SSOLoginOptions extends LoginOptions {
    ssoPasscode: string;
}
export interface CredentialsLoginOptions extends LoginOptions {
    user: string;
    password: string;
}
export interface Organization {
    label: string;
    guid: string;
}
export interface Space {
    label: string;
    guid: string;
    orgGUID: string;
}
export {};