@routr/common 2.0.5-alpha.9 → 2.0.6-alpha.0

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { ServiceDefinition } from "@grpc/proto-loader";
 export declare enum Method {
     UNKNOWN = "UNKNOWN",
     REGISTER = "REGISTER",
@@ -5,7 +6,11 @@ export declare enum Method {
     MESSAGE = "MESSAGE",
     PUBLISH = "PUBLISH",
     NOTIFY = "NOTIFY",
-    SUBSCRIBE = "SUBSCRIBE"
+    SUBSCRIBE = "SUBSCRIBE",
+    ACK = "ACK",
+    BYE = "BYE",
+    CANCEL = "CANCEL",
+    OPTIONS = "OPTIONS"
 }
 export declare enum Transport {
     TCP = "TCP",
@@ -15,6 +20,16 @@ export declare enum Transport {
     WS = "WS",
     WSS = "WSS"
 }
+export declare enum ExtraHeader {
+    REQUEST_URI = "X-Request-Uri",
+    GATEWAY_AUTH = "X-Gateway-Auth",
+    EDGEPORT_REF = "X-Edgeport-Ref",
+    SESSION_COUNT = "X-Session-Count"
+}
+export declare enum Privacy {
+    NONE = "none",
+    PRIVATE = "id"
+}
 export interface NetInterface {
     host: string;
     port: number;
@@ -28,7 +43,7 @@ export interface MessageRequest {
     listeningPoint: NetInterface;
     externalIps: string[];
     localnets: string[];
-    message: Record<string, unknown>;
+    message: SIPMessage;
 }
 export interface MessageResponse {
     message: Record<string, unknown>;
@@ -37,7 +52,6 @@ export interface ProcessorConfig {
     ref: string;
     addr: string;
     methods: Array<Method>;
-    isFallback?: boolean;
     matchFunc?: (request: MessageRequest) => boolean;
 }
 export interface MiddlewareConfig {
@@ -47,8 +61,8 @@ export interface MiddlewareConfig {
 export interface ServiceInfo {
     name: string;
     bindAddr: string;
-    service: unknown;
-    handlers: Record<string, (call: unknown, callback: Function) => unknown>;
+    service: ServiceDefinition;
+    handlers: Record<string, (call: unknown, callback: (error: Error, result: unknown) => void) => unknown>;
 }
 export interface ObjectProto {
     name: string;
@@ -81,15 +95,202 @@ export interface AuthChallengeResponse {
     uri: string;
     method: string;
 }
+export declare enum HeaderModifierAction {
+    ADD = "add",
+    REMOVE = "remove"
+}
+export interface HeaderModifier {
+    name: string;
+    value?: string;
+    action: HeaderModifierAction;
+}
 export interface Route {
     user: string;
     host: string;
     port: number;
     transport: Transport;
-    registeredOn: number;
+    registeredOn?: number;
     sessionCount?: number;
-    expires: number;
+    expires?: number;
     edgePortRef: string;
     listeningPoint: NetInterface;
     labels?: Map<string, string>;
+    headers?: HeaderModifier[];
+}
+export declare enum ResponseType {
+    UNKNOWN = 0,
+    TRYING = 1,
+    RINGING = 2,
+    CALL_IS_BEING_FORWARDED = 3,
+    QUEUED = 4,
+    SESSION_PROGRESS = 5,
+    SUCCESS = 6,
+    OK = 7,
+    ACCEPTED = 8,
+    REDIRECTION = 9,
+    MULTIPLE_CHOICES = 10,
+    MOVED_PERMANENTLY = 11,
+    MOVED_TEMPORARILY = 12,
+    USE_PROXY = 13,
+    ALTERNATIVE_SERVICE = 14,
+    CLIENT_ERROR = 15,
+    BAD_REQUEST = 16,
+    UNAUTHORIZED = 17,
+    PAYMENT_REQUIRED = 18,
+    FORBIDDEN = 19,
+    NOT_FOUND = 20,
+    METHOD_NOT_ALLOWED = 21,
+    NOT_ACCEPTABLE = 22,
+    PROXY_AUTHENTICATION_REQUIRED = 23,
+    REQUEST_TIMEOUT = 24,
+    GONE = 25,
+    REQUEST_ENTITY_TOO_LARGE = 26,
+    REQUEST_URI_TOO_LONG = 27,
+    UNSUPPORTED_MEDIA_TYPE = 28,
+    UNSUPPORTED_URI_SCHEME = 29,
+    BAD_EXTENSION = 30,
+    EXTENSION_REQUIRED = 31,
+    INTERVAL_TOO_BRIEF = 32,
+    TEMPORARILY_UNAVAILABLE = 33,
+    CALL_OR_TRANSACTION_DOES_NOT_EXIST = 34,
+    LOOP_DETECTED = 35,
+    TOO_MANY_HOPS = 36,
+    ADDRESS_INCOMPLETE = 37,
+    AMBIGUOUS = 38,
+    BUSY_HERE = 39,
+    REQUEST_TERMINATED = 40,
+    NOT_ACCEPTABLE_HERE = 41,
+    BAD_EVENT = 42,
+    REQUEST_PENDING = 43,
+    UNDECIPHERABLE = 44,
+    SERVER_ERROR = 45,
+    SERVER_INTERNAL_ERROR = 46,
+    NOT_IMPLEMENTED = 47,
+    BAD_GATEWAY = 48,
+    SERVICE_UNAVAILABLE = 49,
+    SERVER_TIMEOUT = 50,
+    VERSION_NOT_SUPPORTED = 51,
+    MESSAGE_TOO_LARGE = 52,
+    GLOBAL_ERROR = 53,
+    BUSY_EVERYWHERE = 54,
+    DECLINE = 55,
+    DOES_NOT_EXIST_ANYWHERE = 56,
+    SESSION_NOT_ACCEPTABLE = 57
+}
+export interface WWWAuthenticate {
+    realm: string;
+    domain: string;
+    nonce: string;
+    scheme: string;
+    algorithm: string;
+    qop: string;
+    opaque: string;
+    stale: boolean;
+}
+export interface Authorization {
+    realm: string;
+    scheme: string;
+    nonce: string;
+    cNonce: string;
+    nonceCount: number;
+    response: string;
+    username: string;
+    uri: string;
+    algorithm: string;
+    qop: string;
+    opaque: string;
+    method?: string;
+}
+export interface CallID {
+    callId: string;
+}
+export interface ContentLength {
+    contentLength: number;
+}
+export interface Extension {
+    name: string;
+    value: string;
+}
+export interface Via {
+    host: string;
+    port: number;
+    branch?: string;
+    transport: Transport;
+}
+export interface SipURI {
+    user?: string;
+    host: string;
+    port?: number;
+    transportParam: string;
+    mAddrParam?: string;
+    userParam?: string;
+    ttlParam?: number;
+    lrParam?: boolean;
+    methodParam?: string;
+    secure?: boolean;
+    userPassword?: string;
+}
+export interface Address {
+    uri: SipURI;
+    displayName?: string;
+    wildcard?: boolean;
+}
+export interface MaxForwards {
+    maxForwards: number;
+}
+export interface RouteHeader {
+    address: Address;
+    parameters?: Record<string, string>;
+}
+export interface RecordRoute {
+    address: Address;
+    parameters?: Record<string, string>;
+}
+export interface From {
+    address: Address;
+    tag: string;
+    parameters?: Record<string, string>;
+}
+export interface To {
+    address: Address;
+    tag?: string;
+    parameters?: Record<string, string>;
+}
+export interface Contact {
+    address: Address;
+    expires: number;
+    qValue: number;
+}
+export interface Expires {
+    expires: number;
+}
+export declare enum MessageType {
+    REQUEST = "requestUri",
+    RESPONSE = "responseType"
+}
+export interface SIPMessage {
+    messageType: MessageType;
+    responseType?: ResponseType;
+    requestUri?: SipURI;
+    from: From;
+    to: To;
+    contact?: Contact;
+    callId: CallID;
+    contentLength: ContentLength;
+    expires?: Expires;
+    wwwAuthenticate?: WWWAuthenticate;
+    maxForwards: MaxForwards;
+    authorization?: Authorization;
+    extensions?: Extension[];
+    via?: Via[];
+    route?: RouteHeader[];
+    recordRoute?: RecordRoute[];
+}
+export interface GrpcCallback {
+    (error: Error | {
+        code: number;
+    } | null, response?: unknown): void;
+}
+export interface GrpcCall {
+    request: Record<string, any>;
 }

package/dist/types.js

@@ -1,24 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transport = exports.Method = void 0;
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/routr
- *
- * This file is part of Routr
- *
- * Licensed under the MIT License (the "License")
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Privacy = exports.ExtraHeader = exports.Transport = exports.Method = void 0;
 var Method;
 (function (Method) {
     Method["UNKNOWN"] = "UNKNOWN";
@@ -28,6 +10,10 @@ var Method;
     Method["PUBLISH"] = "PUBLISH";
     Method["NOTIFY"] = "NOTIFY";
     Method["SUBSCRIBE"] = "SUBSCRIBE";
+    Method["ACK"] = "ACK";
+    Method["BYE"] = "BYE";
+    Method["CANCEL"] = "CANCEL";
+    Method["OPTIONS"] = "OPTIONS";
 })(Method = exports.Method || (exports.Method = {}));
 var Transport;
 (function (Transport) {
@@ -38,3 +24,86 @@ var Transport;
     Transport["WS"] = "WS";
     Transport["WSS"] = "WSS";
 })(Transport = exports.Transport || (exports.Transport = {}));
+var ExtraHeader;
+(function (ExtraHeader) {
+    ExtraHeader["REQUEST_URI"] = "X-Request-Uri";
+    ExtraHeader["GATEWAY_AUTH"] = "X-Gateway-Auth";
+    ExtraHeader["EDGEPORT_REF"] = "X-Edgeport-Ref";
+    ExtraHeader["SESSION_COUNT"] = "X-Session-Count";
+})(ExtraHeader = exports.ExtraHeader || (exports.ExtraHeader = {}));
+var Privacy;
+(function (Privacy) {
+    Privacy["NONE"] = "none";
+    Privacy["PRIVATE"] = "id";
+})(Privacy = exports.Privacy || (exports.Privacy = {}));
+var HeaderModifierAction;
+(function (HeaderModifierAction) {
+    HeaderModifierAction["ADD"] = "add";
+    HeaderModifierAction["REMOVE"] = "remove";
+})(HeaderModifierAction = exports.HeaderModifierAction || (exports.HeaderModifierAction = {}));
+var ResponseType;
+(function (ResponseType) {
+    ResponseType[ResponseType["UNKNOWN"] = 0] = "UNKNOWN";
+    ResponseType[ResponseType["TRYING"] = 1] = "TRYING";
+    ResponseType[ResponseType["RINGING"] = 2] = "RINGING";
+    ResponseType[ResponseType["CALL_IS_BEING_FORWARDED"] = 3] = "CALL_IS_BEING_FORWARDED";
+    ResponseType[ResponseType["QUEUED"] = 4] = "QUEUED";
+    ResponseType[ResponseType["SESSION_PROGRESS"] = 5] = "SESSION_PROGRESS";
+    ResponseType[ResponseType["SUCCESS"] = 6] = "SUCCESS";
+    ResponseType[ResponseType["OK"] = 7] = "OK";
+    ResponseType[ResponseType["ACCEPTED"] = 8] = "ACCEPTED";
+    ResponseType[ResponseType["REDIRECTION"] = 9] = "REDIRECTION";
+    ResponseType[ResponseType["MULTIPLE_CHOICES"] = 10] = "MULTIPLE_CHOICES";
+    ResponseType[ResponseType["MOVED_PERMANENTLY"] = 11] = "MOVED_PERMANENTLY";
+    ResponseType[ResponseType["MOVED_TEMPORARILY"] = 12] = "MOVED_TEMPORARILY";
+    ResponseType[ResponseType["USE_PROXY"] = 13] = "USE_PROXY";
+    ResponseType[ResponseType["ALTERNATIVE_SERVICE"] = 14] = "ALTERNATIVE_SERVICE";
+    ResponseType[ResponseType["CLIENT_ERROR"] = 15] = "CLIENT_ERROR";
+    ResponseType[ResponseType["BAD_REQUEST"] = 16] = "BAD_REQUEST";
+    ResponseType[ResponseType["UNAUTHORIZED"] = 17] = "UNAUTHORIZED";
+    ResponseType[ResponseType["PAYMENT_REQUIRED"] = 18] = "PAYMENT_REQUIRED";
+    ResponseType[ResponseType["FORBIDDEN"] = 19] = "FORBIDDEN";
+    ResponseType[ResponseType["NOT_FOUND"] = 20] = "NOT_FOUND";
+    ResponseType[ResponseType["METHOD_NOT_ALLOWED"] = 21] = "METHOD_NOT_ALLOWED";
+    ResponseType[ResponseType["NOT_ACCEPTABLE"] = 22] = "NOT_ACCEPTABLE";
+    ResponseType[ResponseType["PROXY_AUTHENTICATION_REQUIRED"] = 23] = "PROXY_AUTHENTICATION_REQUIRED";
+    ResponseType[ResponseType["REQUEST_TIMEOUT"] = 24] = "REQUEST_TIMEOUT";
+    ResponseType[ResponseType["GONE"] = 25] = "GONE";
+    ResponseType[ResponseType["REQUEST_ENTITY_TOO_LARGE"] = 26] = "REQUEST_ENTITY_TOO_LARGE";
+    ResponseType[ResponseType["REQUEST_URI_TOO_LONG"] = 27] = "REQUEST_URI_TOO_LONG";
+    ResponseType[ResponseType["UNSUPPORTED_MEDIA_TYPE"] = 28] = "UNSUPPORTED_MEDIA_TYPE";
+    ResponseType[ResponseType["UNSUPPORTED_URI_SCHEME"] = 29] = "UNSUPPORTED_URI_SCHEME";
+    ResponseType[ResponseType["BAD_EXTENSION"] = 30] = "BAD_EXTENSION";
+    ResponseType[ResponseType["EXTENSION_REQUIRED"] = 31] = "EXTENSION_REQUIRED";
+    ResponseType[ResponseType["INTERVAL_TOO_BRIEF"] = 32] = "INTERVAL_TOO_BRIEF";
+    ResponseType[ResponseType["TEMPORARILY_UNAVAILABLE"] = 33] = "TEMPORARILY_UNAVAILABLE";
+    ResponseType[ResponseType["CALL_OR_TRANSACTION_DOES_NOT_EXIST"] = 34] = "CALL_OR_TRANSACTION_DOES_NOT_EXIST";
+    ResponseType[ResponseType["LOOP_DETECTED"] = 35] = "LOOP_DETECTED";
+    ResponseType[ResponseType["TOO_MANY_HOPS"] = 36] = "TOO_MANY_HOPS";
+    ResponseType[ResponseType["ADDRESS_INCOMPLETE"] = 37] = "ADDRESS_INCOMPLETE";
+    ResponseType[ResponseType["AMBIGUOUS"] = 38] = "AMBIGUOUS";
+    ResponseType[ResponseType["BUSY_HERE"] = 39] = "BUSY_HERE";
+    ResponseType[ResponseType["REQUEST_TERMINATED"] = 40] = "REQUEST_TERMINATED";
+    ResponseType[ResponseType["NOT_ACCEPTABLE_HERE"] = 41] = "NOT_ACCEPTABLE_HERE";
+    ResponseType[ResponseType["BAD_EVENT"] = 42] = "BAD_EVENT";
+    ResponseType[ResponseType["REQUEST_PENDING"] = 43] = "REQUEST_PENDING";
+    ResponseType[ResponseType["UNDECIPHERABLE"] = 44] = "UNDECIPHERABLE";
+    ResponseType[ResponseType["SERVER_ERROR"] = 45] = "SERVER_ERROR";
+    ResponseType[ResponseType["SERVER_INTERNAL_ERROR"] = 46] = "SERVER_INTERNAL_ERROR";
+    ResponseType[ResponseType["NOT_IMPLEMENTED"] = 47] = "NOT_IMPLEMENTED";
+    ResponseType[ResponseType["BAD_GATEWAY"] = 48] = "BAD_GATEWAY";
+    ResponseType[ResponseType["SERVICE_UNAVAILABLE"] = 49] = "SERVICE_UNAVAILABLE";
+    ResponseType[ResponseType["SERVER_TIMEOUT"] = 50] = "SERVER_TIMEOUT";
+    ResponseType[ResponseType["VERSION_NOT_SUPPORTED"] = 51] = "VERSION_NOT_SUPPORTED";
+    ResponseType[ResponseType["MESSAGE_TOO_LARGE"] = 52] = "MESSAGE_TOO_LARGE";
+    ResponseType[ResponseType["GLOBAL_ERROR"] = 53] = "GLOBAL_ERROR";
+    ResponseType[ResponseType["BUSY_EVERYWHERE"] = 54] = "BUSY_EVERYWHERE";
+    ResponseType[ResponseType["DECLINE"] = 55] = "DECLINE";
+    ResponseType[ResponseType["DOES_NOT_EXIST_ANYWHERE"] = 56] = "DOES_NOT_EXIST_ANYWHERE";
+    ResponseType[ResponseType["SESSION_NOT_ACCEPTABLE"] = 57] = "SESSION_NOT_ACCEPTABLE";
+})(ResponseType = exports.ResponseType || (exports.ResponseType = {}));
+var MessageType;
+(function (MessageType) {
+    MessageType["REQUEST"] = "requestUri";
+    MessageType["RESPONSE"] = "responseType";
+})(MessageType = exports.MessageType || (exports.MessageType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.5-alpha.9",
+  "version": "2.0.6-alpha.0",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -13,9 +13,17 @@
     "postbuild": "mkdir -p dist/protos && cp src/protos/* dist/protos"
   },
   "dependencies": {
-    "@fonoster/logger": "^0.3.3",
+    "@fonoster/logger": "0.3.17-alpha.2",
     "@grpc/grpc-js": "^1.5.9",
     "@grpc/proto-loader": "^0.6.9",
+    "@opentelemetry/api": "^1.0.4",
+    "@opentelemetry/exporter-jaeger": "^1.0.4",
+    "@opentelemetry/instrumentation": "^0.27.0",
+    "@opentelemetry/instrumentation-grpc": "^0.27.0",
+    "@opentelemetry/resources": "^1.0.4",
+    "@opentelemetry/sdk-trace-base": "^1.0.4",
+    "@opentelemetry/sdk-trace-node": "^1.0.4",
+    "@opentelemetry/semantic-conventions": "^1.0.4",
     "fp-ts": "^2.11.8",
     "ip-utils": "^2.4.0"
   },
@@ -36,5 +44,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "9eeafebb3f16625aca520268ed6f44896656f3a6"
+  "gitHead": "0829f7e9b5b3ebba7eb984da5436d7c07689d776"
 }