@vtex/api/lib/constants.d.ts

VTEX I/O API client

export declare const NODE_VTEX_API_VERSION: any;
export declare const DEFAULT_WORKSPACE = "master";
export declare const IS_IO: string | undefined;
export declare const PID: number;
export declare const HeaderKeys: {
    CACHE_CONTROL: string;
    SEGMENT: string;
    SESSION: string;
    PRODUCT: string;
    LOCALE: string;
    FORWARDED_HOST: string;
    FORWARDED_FOR: string;
    TENANT: string;
    BINDING: string;
    META: string;
    META_BUCKET: string;
    ETAG: string;
    ACCOUNT: string;
    CREDENTIAL: string;
    REQUEST_ID: string;
    ROUTER_CACHE: string;
    OPERATION_ID: string;
    PLATFORM: string;
    WORKSPACE_IS_PRODUCTION: string;
    WORKSPACE: string;
    EVENT_KEY: string;
    EVENT_SENDER: string;
    EVENT_SUBJECT: string;
    EVENT_HANDLER_ID: string;
    COLOSSUS_ROUTE_DECLARER: string;
    COLOSSUS_ROUTE_ID: string;
    COLOSSUS_PARAMS: string;
    TRACE_ID: string;
    PROVIDER: string;
    USER_AGENT: string;
    VTEX_USER_AGENT: string;
    VTEX_IO_CALLER: string;
    VTEX_APP_SERVICE: string;
    VTEX_APP_KEY: string;
    VTEX_RETRY_COUNT: string;
};
export declare const AttributeKeys: {
    VTEX_ACCOUNT_NAME: "vtex.account.name";
    VTEX_IO_WORKSPACE_NAME: "vtex_io.workspace.name";
    VTEX_IO_WORKSPACE_TYPE: "vtex_io.workspace.type";
    VTEX_IO_APP_ID: "vtex_io.app.id";
    VTEX_IO_APP_AUTHOR_TYPE: "vtex_io.app.author_type";
};
/** @deprecated Use HeaderKeys.CACHE_CONTROL instead */
export declare const CACHE_CONTROL_HEADER: string;
/** @deprecated Use HeaderKeys.SEGMENT instead */
export declare const SEGMENT_HEADER: string;
/** @deprecated Use HeaderKeys.SESSION instead */
export declare const SESSION_HEADER: string;
/** @deprecated Use HeaderKeys.PRODUCT instead */
export declare const PRODUCT_HEADER: string;
/** @deprecated Use HeaderKeys.LOCALE instead */
export declare const LOCALE_HEADER: string;
/** @deprecated Use HeaderKeys.FORWARDED_HOST instead */
export declare const FORWARDED_HOST_HEADER: string;
/** @deprecated Use HeaderKeys.TENANT instead */
export declare const TENANT_HEADER: string;
/** @deprecated Use HeaderKeys.BINDING instead */
export declare const BINDING_HEADER: string;
/** @deprecated Use HeaderKeys.META instead */
export declare const META_HEADER: string;
/** @deprecated Use HeaderKeys.META_BUCKET instead */
export declare const META_HEADER_BUCKET: string;
/** @deprecated Use HeaderKeys.ETAG instead */
export declare const ETAG_HEADER: string;
/** @deprecated Use HeaderKeys.ACCOUNT instead */
export declare const ACCOUNT_HEADER: string;
/** @deprecated Use HeaderKeys.CREDENTIAL instead */
export declare const CREDENTIAL_HEADER: string;
/** @deprecated Use HeaderKeys.REQUEST_ID instead */
export declare const REQUEST_ID_HEADER: string;
/** @deprecated Use HeaderKeys.ROUTER_CACHE instead */
export declare const ROUTER_CACHE_HEADER: string;
/** @deprecated Use HeaderKeys.OPERATION_ID instead */
export declare const OPERATION_ID_HEADER: string;
/** @deprecated Use HeaderKeys.PLATFORM instead */
export declare const PLATFORM_HEADER: string;
/** @deprecated Use HeaderKeys.WORKSPACE_IS_PRODUCTION instead */
export declare const WORKSPACE_IS_PRODUCTION_HEADER: string;
/** @deprecated Use HeaderKeys.WORKSPACE instead */
export declare const WORKSPACE_HEADER: string;
/** @deprecated Use HeaderKeys.EVENT_KEY instead */
export declare const EVENT_KEY_HEADER: string;
/** @deprecated Use HeaderKeys.EVENT_SENDER instead */
export declare const EVENT_SENDER_HEADER: string;
/** @deprecated Use HeaderKeys.EVENT_SUBJECT instead */
export declare const EVENT_SUBJECT_HEADER: string;
/** @deprecated Use HeaderKeys.EVENT_HANDLER_ID instead */
export declare const EVENT_HANDLER_ID_HEADER: string;
/** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_DECLARER instead */
export declare const COLOSSUS_ROUTE_DECLARER_HEADER: string;
/** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_ID instead */
export declare const COLOSSUS_ROUTE_ID_HEADER: string;
/** @deprecated Use HeaderKeys.COLOSSUS_PARAMS instead */
export declare const COLOSSUS_PARAMS_HEADER: string;
/** @deprecated Use HeaderKeys.TRACE_ID instead */
export declare const TRACE_ID_HEADER: string;
/** @deprecated Use HeaderKeys.PROVIDER instead */
export declare const PROVIDER_HEADER: string;
export type VaryHeaders = typeof HeaderKeys.SEGMENT | typeof HeaderKeys.SESSION | typeof HeaderKeys.PRODUCT | typeof HeaderKeys.LOCALE;
export declare const BODY_HASH = "__graphqlBodyHash";
export declare const UP_SIGNAL = "UP";
export declare const MAX_AGE: {
    LONG: number;
    MEDIUM: number;
    SHORT: number;
};
export declare const HTTP_SERVER_PORT = 5050;
export declare const MAX_WORKERS = 4;
export declare const LINKED: boolean;
export declare const REGION: string;
export declare const PUBLIC_ENDPOINT: string;
export declare const APP: {
    ID: string;
    MAJOR: string;
    NAME: string;
    VENDOR: string;
    VERSION: string;
    IS_THIRD_PARTY(): boolean;
};
export declare const NODE_ENV: string;
export declare const ACCOUNT: string;
export declare const WORKSPACE: string;
export declare const PRODUCTION: boolean;
export declare const INSPECT_DEBUGGER_PORT = 5858;
export declare const cancellableMethods: Set<string>;
export declare const LOG_CLIENT_INIT_TIMEOUT_MS = 5000;
export declare const METRIC_CLIENT_INIT_TIMEOUT_MS = 5000;
export declare const OTEL_EXPORTER_OTLP_ENDPOINT: string;
export declare const DK_APP_ID: string;
export declare const DIAGNOSTICS_TELEMETRY_ENABLED: boolean;