@lazycatcloud/sdk 0.1.488 → 0.1.489

package/dist/common/gateway.d.ts

@@ -1,249 +0,0 @@
-import { grpc } from "@improbable-eng/grpc-web";
-import Long from "long";
-import _m0 from "protobufjs/minimal";
-import { Empty } from "../google/protobuf/empty";
-export declare enum TransportType {
-    /** TCP - 通用性最强，但会占用额外的端口并走完整的TCP/IP栈 */
-    TCP = 0,
-    /**
-     * InProcess - 仅限服务与Gateway同一进程内调用，数据直接走内存。性能最好，主要是device api类型使用。第三方服务无法使用此类型，仅限内部使用
-     * 特殊接口调用。
-     */
-    InProcess = 1,
-    /** UnixSocket - 走unix socket, 依旧是跨进程但不走TCP/IP协议栈。性能一般，不要求同一进程，但需要让gateway本身能访问到对应服务的socket文件 */
-    UnixSocket = 2,
-    UNRECOGNIZED = -1
-}
-export declare function transportTypeFromJSON(object: any): TransportType;
-export declare function transportTypeToJSON(object: TransportType): string;
-export declare enum ServiceType {
-    /**
-     * GRPC - 服务以grpc native的形式曝露给gateway。调用者拨号时直接使用gateway的地址即可，gateway会自动代理对应service name到正确的
-     * 服务后端。
-     */
-    GRPC = 0,
-    /**
-     * HTTP - 服务以http的形式曝露给gateway。 调用者以https的形式访问gateway的地址下的特定url path来访问对应服务后端。
-     * 服务会统一曝露到 `https://api.$boxdomain/s/$service_name/`
-     */
-    HTTP = 1,
-    UNRECOGNIZED = -1
-}
-export declare function serviceTypeFromJSON(object: any): ServiceType;
-export declare function serviceTypeToJSON(object: ServiceType): string;
-export interface GatewayInfo {
-    /** 域名信息 */
-    baseDomain: string;
-    /** 服务端口 */
-    port: string;
-    /** 是否使用TLS */
-    isTls: boolean;
-}
-export interface ServiceInfo {
-    serviceType: ServiceType;
-    /**
-     * 如果是盒子上的第三方服务，则会强制验证$service_name是否与调用者的$appid匹配
-     * 系统内置的服务以及device apis不会做此检查
-     */
-    serviceName: string;
-    transportType: TransportType;
-    serviceAddr: string;
-}
-export interface RegisterReply {
-    isOk: boolean;
-    errorMessage: string;
-    /**
-     * gateway会对appid以及uid进行合法性检测，并在将request传递到service后端前，
-     * 设置到对应的grpc metadata或http header中，具体的字段名称会通过app_id_key以及user_id_key返回
-     */
-    appidKey: string;
-    uidKey: string;
-}
-export interface AccessHTTPServiceRequest {
-    serviceName: string;
-}
-export interface HTTPAccessInfo {
-    /** 对应服务的URL */
-    serviceUrl: string;
-    /**
-     * 若token_headername不为空，
-     * 则必须设置名称为$token_headername的http header为$token_value
-     */
-    authHeadername: string;
-    authValue: string;
-}
-export declare const GatewayInfo: {
-    encode(message: GatewayInfo, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): GatewayInfo;
-    fromJSON(object: any): GatewayInfo;
-    toJSON(message: GatewayInfo): unknown;
-    create<I extends {
-        baseDomain?: string;
-        port?: string;
-        isTls?: boolean;
-    } & {
-        baseDomain?: string;
-        port?: string;
-        isTls?: boolean;
-    } & { [K in Exclude<keyof I, keyof GatewayInfo>]: never; }>(base?: I): GatewayInfo;
-    fromPartial<I_1 extends {
-        baseDomain?: string;
-        port?: string;
-        isTls?: boolean;
-    } & {
-        baseDomain?: string;
-        port?: string;
-        isTls?: boolean;
-    } & { [K_1 in Exclude<keyof I_1, keyof GatewayInfo>]: never; }>(object: I_1): GatewayInfo;
-};
-export declare const ServiceInfo: {
-    encode(message: ServiceInfo, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): ServiceInfo;
-    fromJSON(object: any): ServiceInfo;
-    toJSON(message: ServiceInfo): unknown;
-    create<I extends {
-        serviceType?: ServiceType;
-        serviceName?: string;
-        transportType?: TransportType;
-        serviceAddr?: string;
-    } & {
-        serviceType?: ServiceType;
-        serviceName?: string;
-        transportType?: TransportType;
-        serviceAddr?: string;
-    } & { [K in Exclude<keyof I, keyof ServiceInfo>]: never; }>(base?: I): ServiceInfo;
-    fromPartial<I_1 extends {
-        serviceType?: ServiceType;
-        serviceName?: string;
-        transportType?: TransportType;
-        serviceAddr?: string;
-    } & {
-        serviceType?: ServiceType;
-        serviceName?: string;
-        transportType?: TransportType;
-        serviceAddr?: string;
-    } & { [K_1 in Exclude<keyof I_1, keyof ServiceInfo>]: never; }>(object: I_1): ServiceInfo;
-};
-export declare const RegisterReply: {
-    encode(message: RegisterReply, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): RegisterReply;
-    fromJSON(object: any): RegisterReply;
-    toJSON(message: RegisterReply): unknown;
-    create<I extends {
-        isOk?: boolean;
-        errorMessage?: string;
-        appidKey?: string;
-        uidKey?: string;
-    } & {
-        isOk?: boolean;
-        errorMessage?: string;
-        appidKey?: string;
-        uidKey?: string;
-    } & { [K in Exclude<keyof I, keyof RegisterReply>]: never; }>(base?: I): RegisterReply;
-    fromPartial<I_1 extends {
-        isOk?: boolean;
-        errorMessage?: string;
-        appidKey?: string;
-        uidKey?: string;
-    } & {
-        isOk?: boolean;
-        errorMessage?: string;
-        appidKey?: string;
-        uidKey?: string;
-    } & { [K_1 in Exclude<keyof I_1, keyof RegisterReply>]: never; }>(object: I_1): RegisterReply;
-};
-export declare const AccessHTTPServiceRequest: {
-    encode(message: AccessHTTPServiceRequest, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): AccessHTTPServiceRequest;
-    fromJSON(object: any): AccessHTTPServiceRequest;
-    toJSON(message: AccessHTTPServiceRequest): unknown;
-    create<I extends {
-        serviceName?: string;
-    } & {
-        serviceName?: string;
-    } & { [K in Exclude<keyof I, "serviceName">]: never; }>(base?: I): AccessHTTPServiceRequest;
-    fromPartial<I_1 extends {
-        serviceName?: string;
-    } & {
-        serviceName?: string;
-    } & { [K_1 in Exclude<keyof I_1, "serviceName">]: never; }>(object: I_1): AccessHTTPServiceRequest;
-};
-export declare const HTTPAccessInfo: {
-    encode(message: HTTPAccessInfo, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): HTTPAccessInfo;
-    fromJSON(object: any): HTTPAccessInfo;
-    toJSON(message: HTTPAccessInfo): unknown;
-    create<I extends {
-        serviceUrl?: string;
-        authHeadername?: string;
-        authValue?: string;
-    } & {
-        serviceUrl?: string;
-        authHeadername?: string;
-        authValue?: string;
-    } & { [K in Exclude<keyof I, keyof HTTPAccessInfo>]: never; }>(base?: I): HTTPAccessInfo;
-    fromPartial<I_1 extends {
-        serviceUrl?: string;
-        authHeadername?: string;
-        authValue?: string;
-    } & {
-        serviceUrl?: string;
-        authHeadername?: string;
-        authValue?: string;
-    } & { [K_1 in Exclude<keyof I_1, keyof HTTPAccessInfo>]: never; }>(object: I_1): HTTPAccessInfo;
-};
-export interface APIGateway {
-    QueryGatewayInfo(request: DeepPartial<Empty>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<GatewayInfo>;
-    RegisterService(request: DeepPartial<ServiceInfo>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<RegisterReply>;
-    /**
-     * 访问http service前，需要申请auth信息以便Gateway可以识别来源对应的
-     * 真实appid。
-     * 返回值尽量交由浏览器前端设置xhr对应参数。如果确实无法做到(比如img src中)，则
-     * 可以通过https://$appdomain/$service_proxy/的形式由/usr/bin/lzcapp代为
-     * 转发。此前缀可以通过BrowserOnlyProxy.proto接口获取到。
-     */
-    AccessHTTPService(request: DeepPartial<AccessHTTPServiceRequest>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<HTTPAccessInfo>;
-}
-export declare class APIGatewayClientImpl implements APIGateway {
-    private readonly rpc;
-    constructor(rpc: Rpc);
-    QueryGatewayInfo(request: DeepPartial<Empty>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<GatewayInfo>;
-    RegisterService(request: DeepPartial<ServiceInfo>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<RegisterReply>;
-    AccessHTTPService(request: DeepPartial<AccessHTTPServiceRequest>, metadata?: grpc.Metadata, abortSignal?: AbortSignal): Promise<HTTPAccessInfo>;
-}
-export declare const APIGatewayDesc: {
-    serviceName: string;
-};
-export declare const APIGatewayQueryGatewayInfoDesc: UnaryMethodDefinitionish;
-export declare const APIGatewayRegisterServiceDesc: UnaryMethodDefinitionish;
-export declare const APIGatewayAccessHTTPServiceDesc: UnaryMethodDefinitionish;
-interface UnaryMethodDefinitionishR extends grpc.UnaryMethodDefinition<any, any> {
-    requestStream: any;
-    responseStream: any;
-}
-type UnaryMethodDefinitionish = UnaryMethodDefinitionishR;
-interface Rpc {
-    unary<T extends UnaryMethodDefinitionish>(methodDesc: T, request: any, metadata: grpc.Metadata | undefined, abortSignal?: AbortSignal): Promise<any>;
-}
-export declare class GrpcWebImpl {
-    private host;
-    private options;
-    constructor(host: string, options: {
-        transport?: grpc.TransportFactory;
-        debug?: boolean;
-        metadata?: grpc.Metadata;
-        upStreamRetryCodes?: number[];
-    });
-    unary<T extends UnaryMethodDefinitionish>(methodDesc: T, _request: any, metadata: grpc.Metadata | undefined, abortSignal?: AbortSignal): Promise<any>;
-}
-declare const tsProtoGlobalThis: any;
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : Partial<T>;
-export declare class GrpcWebError extends tsProtoGlobalThis.Error {
-    code: grpc.Code;
-    metadata: grpc.Metadata;
-    constructor(message: string, code: grpc.Code, metadata: grpc.Metadata);
-}
-export {};