@lazycatcloud/sdk 0.1.142 → 0.1.144

package/common/gateway.ts

@@ -0,0 +1,663 @@
+/* eslint-disable */
+import { grpc } from "@improbable-eng/grpc-web";
+import { BrowserHeaders } from "browser-headers";
+import _m0 from "protobufjs/minimal";
+import { Empty } from "../google/protobuf/empty";
+
+export 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 function transportTypeFromJSON(object: any): TransportType {
+  switch (object) {
+    case 0:
+    case "TCP":
+      return TransportType.TCP;
+    case 1:
+    case "InProcess":
+      return TransportType.InProcess;
+    case 2:
+    case "UnixSocket":
+      return TransportType.UnixSocket;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return TransportType.UNRECOGNIZED;
+  }
+}
+
+export function transportTypeToJSON(object: TransportType): string {
+  switch (object) {
+    case TransportType.TCP:
+      return "TCP";
+    case TransportType.InProcess:
+      return "InProcess";
+    case TransportType.UnixSocket:
+      return "UnixSocket";
+    case TransportType.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
+export 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 function serviceTypeFromJSON(object: any): ServiceType {
+  switch (object) {
+    case 0:
+    case "GRPC":
+      return ServiceType.GRPC;
+    case 1:
+    case "HTTP":
+      return ServiceType.HTTP;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return ServiceType.UNRECOGNIZED;
+  }
+}
+
+export function serviceTypeToJSON(object: ServiceType): string {
+  switch (object) {
+    case ServiceType.GRPC:
+      return "GRPC";
+    case ServiceType.HTTP:
+      return "HTTP";
+    case ServiceType.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
+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;
+}
+
+function createBaseGatewayInfo(): GatewayInfo {
+  return { baseDomain: "", port: "", isTls: false };
+}
+
+export const GatewayInfo = {
+  encode(message: GatewayInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.baseDomain !== "") {
+      writer.uint32(10).string(message.baseDomain);
+    }
+    if (message.port !== "") {
+      writer.uint32(18).string(message.port);
+    }
+    if (message.isTls === true) {
+      writer.uint32(24).bool(message.isTls);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): GatewayInfo {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseGatewayInfo();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.baseDomain = reader.string();
+          break;
+        case 2:
+          message.port = reader.string();
+          break;
+        case 3:
+          message.isTls = reader.bool();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): GatewayInfo {
+    return {
+      baseDomain: isSet(object.baseDomain) ? String(object.baseDomain) : "",
+      port: isSet(object.port) ? String(object.port) : "",
+      isTls: isSet(object.isTls) ? Boolean(object.isTls) : false,
+    };
+  },
+
+  toJSON(message: GatewayInfo): unknown {
+    const obj: any = {};
+    message.baseDomain !== undefined && (obj.baseDomain = message.baseDomain);
+    message.port !== undefined && (obj.port = message.port);
+    message.isTls !== undefined && (obj.isTls = message.isTls);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<GatewayInfo>, I>>(object: I): GatewayInfo {
+    const message = createBaseGatewayInfo();
+    message.baseDomain = object.baseDomain ?? "";
+    message.port = object.port ?? "";
+    message.isTls = object.isTls ?? false;
+    return message;
+  },
+};
+
+function createBaseServiceInfo(): ServiceInfo {
+  return { serviceType: 0, serviceName: "", transportType: 0, serviceAddr: "" };
+}
+
+export const ServiceInfo = {
+  encode(message: ServiceInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.serviceType !== 0) {
+      writer.uint32(8).int32(message.serviceType);
+    }
+    if (message.serviceName !== "") {
+      writer.uint32(18).string(message.serviceName);
+    }
+    if (message.transportType !== 0) {
+      writer.uint32(24).int32(message.transportType);
+    }
+    if (message.serviceAddr !== "") {
+      writer.uint32(34).string(message.serviceAddr);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ServiceInfo {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseServiceInfo();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.serviceType = reader.int32() as any;
+          break;
+        case 2:
+          message.serviceName = reader.string();
+          break;
+        case 3:
+          message.transportType = reader.int32() as any;
+          break;
+        case 4:
+          message.serviceAddr = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ServiceInfo {
+    return {
+      serviceType: isSet(object.serviceType) ? serviceTypeFromJSON(object.serviceType) : 0,
+      serviceName: isSet(object.serviceName) ? String(object.serviceName) : "",
+      transportType: isSet(object.transportType) ? transportTypeFromJSON(object.transportType) : 0,
+      serviceAddr: isSet(object.serviceAddr) ? String(object.serviceAddr) : "",
+    };
+  },
+
+  toJSON(message: ServiceInfo): unknown {
+    const obj: any = {};
+    message.serviceType !== undefined && (obj.serviceType = serviceTypeToJSON(message.serviceType));
+    message.serviceName !== undefined && (obj.serviceName = message.serviceName);
+    message.transportType !== undefined && (obj.transportType = transportTypeToJSON(message.transportType));
+    message.serviceAddr !== undefined && (obj.serviceAddr = message.serviceAddr);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<ServiceInfo>, I>>(object: I): ServiceInfo {
+    const message = createBaseServiceInfo();
+    message.serviceType = object.serviceType ?? 0;
+    message.serviceName = object.serviceName ?? "";
+    message.transportType = object.transportType ?? 0;
+    message.serviceAddr = object.serviceAddr ?? "";
+    return message;
+  },
+};
+
+function createBaseRegisterReply(): RegisterReply {
+  return { isOk: false, errorMessage: "", appidKey: "", uidKey: "" };
+}
+
+export const RegisterReply = {
+  encode(message: RegisterReply, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.isOk === true) {
+      writer.uint32(8).bool(message.isOk);
+    }
+    if (message.errorMessage !== "") {
+      writer.uint32(18).string(message.errorMessage);
+    }
+    if (message.appidKey !== "") {
+      writer.uint32(26).string(message.appidKey);
+    }
+    if (message.uidKey !== "") {
+      writer.uint32(34).string(message.uidKey);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): RegisterReply {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseRegisterReply();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.isOk = reader.bool();
+          break;
+        case 2:
+          message.errorMessage = reader.string();
+          break;
+        case 3:
+          message.appidKey = reader.string();
+          break;
+        case 4:
+          message.uidKey = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): RegisterReply {
+    return {
+      isOk: isSet(object.isOk) ? Boolean(object.isOk) : false,
+      errorMessage: isSet(object.errorMessage) ? String(object.errorMessage) : "",
+      appidKey: isSet(object.appidKey) ? String(object.appidKey) : "",
+      uidKey: isSet(object.uidKey) ? String(object.uidKey) : "",
+    };
+  },
+
+  toJSON(message: RegisterReply): unknown {
+    const obj: any = {};
+    message.isOk !== undefined && (obj.isOk = message.isOk);
+    message.errorMessage !== undefined && (obj.errorMessage = message.errorMessage);
+    message.appidKey !== undefined && (obj.appidKey = message.appidKey);
+    message.uidKey !== undefined && (obj.uidKey = message.uidKey);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<RegisterReply>, I>>(object: I): RegisterReply {
+    const message = createBaseRegisterReply();
+    message.isOk = object.isOk ?? false;
+    message.errorMessage = object.errorMessage ?? "";
+    message.appidKey = object.appidKey ?? "";
+    message.uidKey = object.uidKey ?? "";
+    return message;
+  },
+};
+
+function createBaseAccessHTTPServiceRequest(): AccessHTTPServiceRequest {
+  return { serviceName: "" };
+}
+
+export const AccessHTTPServiceRequest = {
+  encode(message: AccessHTTPServiceRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.serviceName !== "") {
+      writer.uint32(10).string(message.serviceName);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): AccessHTTPServiceRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAccessHTTPServiceRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.serviceName = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): AccessHTTPServiceRequest {
+    return { serviceName: isSet(object.serviceName) ? String(object.serviceName) : "" };
+  },
+
+  toJSON(message: AccessHTTPServiceRequest): unknown {
+    const obj: any = {};
+    message.serviceName !== undefined && (obj.serviceName = message.serviceName);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<AccessHTTPServiceRequest>, I>>(object: I): AccessHTTPServiceRequest {
+    const message = createBaseAccessHTTPServiceRequest();
+    message.serviceName = object.serviceName ?? "";
+    return message;
+  },
+};
+
+function createBaseHTTPAccessInfo(): HTTPAccessInfo {
+  return { serviceUrl: "", authHeadername: "", authValue: "" };
+}
+
+export const HTTPAccessInfo = {
+  encode(message: HTTPAccessInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.serviceUrl !== "") {
+      writer.uint32(10).string(message.serviceUrl);
+    }
+    if (message.authHeadername !== "") {
+      writer.uint32(18).string(message.authHeadername);
+    }
+    if (message.authValue !== "") {
+      writer.uint32(26).string(message.authValue);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): HTTPAccessInfo {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseHTTPAccessInfo();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.serviceUrl = reader.string();
+          break;
+        case 2:
+          message.authHeadername = reader.string();
+          break;
+        case 3:
+          message.authValue = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): HTTPAccessInfo {
+    return {
+      serviceUrl: isSet(object.serviceUrl) ? String(object.serviceUrl) : "",
+      authHeadername: isSet(object.authHeadername) ? String(object.authHeadername) : "",
+      authValue: isSet(object.authValue) ? String(object.authValue) : "",
+    };
+  },
+
+  toJSON(message: HTTPAccessInfo): unknown {
+    const obj: any = {};
+    message.serviceUrl !== undefined && (obj.serviceUrl = message.serviceUrl);
+    message.authHeadername !== undefined && (obj.authHeadername = message.authHeadername);
+    message.authValue !== undefined && (obj.authValue = message.authValue);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<HTTPAccessInfo>, I>>(object: I): HTTPAccessInfo {
+    const message = createBaseHTTPAccessInfo();
+    message.serviceUrl = object.serviceUrl ?? "";
+    message.authHeadername = object.authHeadername ?? "";
+    message.authValue = object.authValue ?? "";
+    return message;
+  },
+};
+
+export interface APIGateway {
+  QueryGatewayInfo(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Promise<GatewayInfo>;
+  RegisterService(request: DeepPartial<ServiceInfo>, metadata?: grpc.Metadata): 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): Promise<HTTPAccessInfo>;
+}
+
+export class APIGatewayClientImpl implements APIGateway {
+  private readonly rpc: Rpc;
+
+  constructor(rpc: Rpc) {
+    this.rpc = rpc;
+    this.QueryGatewayInfo = this.QueryGatewayInfo.bind(this);
+    this.RegisterService = this.RegisterService.bind(this);
+    this.AccessHTTPService = this.AccessHTTPService.bind(this);
+  }
+
+  QueryGatewayInfo(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Promise<GatewayInfo> {
+    return this.rpc.unary(APIGatewayQueryGatewayInfoDesc, Empty.fromPartial(request), metadata);
+  }
+
+  RegisterService(request: DeepPartial<ServiceInfo>, metadata?: grpc.Metadata): Promise<RegisterReply> {
+    return this.rpc.unary(APIGatewayRegisterServiceDesc, ServiceInfo.fromPartial(request), metadata);
+  }
+
+  AccessHTTPService(request: DeepPartial<AccessHTTPServiceRequest>, metadata?: grpc.Metadata): Promise<HTTPAccessInfo> {
+    return this.rpc.unary(APIGatewayAccessHTTPServiceDesc, AccessHTTPServiceRequest.fromPartial(request), metadata);
+  }
+}
+
+export const APIGatewayDesc = { serviceName: "cloud.lazycat.apis.common.APIGateway" };
+
+export const APIGatewayQueryGatewayInfoDesc: UnaryMethodDefinitionish = {
+  methodName: "QueryGatewayInfo",
+  service: APIGatewayDesc,
+  requestStream: false,
+  responseStream: false,
+  requestType: {
+    serializeBinary() {
+      return Empty.encode(this).finish();
+    },
+  } as any,
+  responseType: {
+    deserializeBinary(data: Uint8Array) {
+      return {
+        ...GatewayInfo.decode(data),
+        toObject() {
+          return this;
+        },
+      };
+    },
+  } as any,
+};
+
+export const APIGatewayRegisterServiceDesc: UnaryMethodDefinitionish = {
+  methodName: "RegisterService",
+  service: APIGatewayDesc,
+  requestStream: false,
+  responseStream: false,
+  requestType: {
+    serializeBinary() {
+      return ServiceInfo.encode(this).finish();
+    },
+  } as any,
+  responseType: {
+    deserializeBinary(data: Uint8Array) {
+      return {
+        ...RegisterReply.decode(data),
+        toObject() {
+          return this;
+        },
+      };
+    },
+  } as any,
+};
+
+export const APIGatewayAccessHTTPServiceDesc: UnaryMethodDefinitionish = {
+  methodName: "AccessHTTPService",
+  service: APIGatewayDesc,
+  requestStream: false,
+  responseStream: false,
+  requestType: {
+    serializeBinary() {
+      return AccessHTTPServiceRequest.encode(this).finish();
+    },
+  } as any,
+  responseType: {
+    deserializeBinary(data: Uint8Array) {
+      return {
+        ...HTTPAccessInfo.decode(data),
+        toObject() {
+          return this;
+        },
+      };
+    },
+  } as any,
+};
+
+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,
+  ): Promise<any>;
+}
+
+export class GrpcWebImpl {
+  private host: string;
+  private options: {
+    transport?: grpc.TransportFactory;
+
+    debug?: boolean;
+    metadata?: grpc.Metadata;
+    upStreamRetryCodes?: number[];
+  };
+
+  constructor(
+    host: string,
+    options: {
+      transport?: grpc.TransportFactory;
+
+      debug?: boolean;
+      metadata?: grpc.Metadata;
+      upStreamRetryCodes?: number[];
+    },
+  ) {
+    this.host = host;
+    this.options = options;
+  }
+
+  unary<T extends UnaryMethodDefinitionish>(
+    methodDesc: T,
+    _request: any,
+    metadata: grpc.Metadata | undefined,
+  ): Promise<any> {
+    const request = { ..._request, ...methodDesc.requestType };
+    const maybeCombinedMetadata = metadata && this.options.metadata
+      ? new BrowserHeaders({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
+      : metadata || this.options.metadata;
+    return new Promise((resolve, reject) => {
+      grpc.unary(methodDesc, {
+        request,
+        host: this.host,
+        metadata: maybeCombinedMetadata,
+        transport: this.options.transport,
+        debug: this.options.debug,
+        onEnd: function (response) {
+          if (response.status === grpc.Code.OK) {
+            resolve(response.message);
+          } else {
+            const err = new GrpcWebError(response.statusMessage, response.status, response.trailers);
+            reject(err);
+          }
+        },
+      });
+    });
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+type DeepPartial<T> = T extends Builtin ? T
+  : 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>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+export class GrpcWebError extends Error {
+  constructor(message: string, public code: grpc.Code, public metadata: grpc.Metadata) {
+    super(message);
+  }
+}