@routr/connect 2.17.0 → 2.19.0

package/dist/envs.d.ts

@@ -4,6 +4,7 @@ export declare const API_ADDR: string;
 export declare const CONNECT_VERIFIER_ADDR: string;
 export declare const CONNECT_VERIFIER_PUBLIC_KEY_PATH: string;
 export declare const CONNECT_VERIFIER_OPTIONS: any;
+export declare const REGISTER_DEFAULT_EXPIRES: number;
 export declare const DEFAULT_UNTRUSTED_HEADERS_TO_STRIP: string[];
 export declare const UNTRUSTED_HEADERS_TO_STRIP: string[];
 export declare const TRUSTED_EDGEPORTS: string[];

package/dist/envs.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TRUSTED_EDGEPORT_ADDRESSES = exports.TRUSTED_EDGEPORTS = exports.UNTRUSTED_HEADERS_TO_STRIP = exports.DEFAULT_UNTRUSTED_HEADERS_TO_STRIP = exports.CONNECT_VERIFIER_OPTIONS = exports.CONNECT_VERIFIER_PUBLIC_KEY_PATH = exports.CONNECT_VERIFIER_ADDR = exports.API_ADDR = exports.LOCATION_ADDR = exports.BIND_ADDR = void 0;
+exports.TRUSTED_EDGEPORT_ADDRESSES = exports.TRUSTED_EDGEPORTS = exports.UNTRUSTED_HEADERS_TO_STRIP = exports.DEFAULT_UNTRUSTED_HEADERS_TO_STRIP = exports.REGISTER_DEFAULT_EXPIRES = exports.CONNECT_VERIFIER_OPTIONS = exports.CONNECT_VERIFIER_PUBLIC_KEY_PATH = exports.CONNECT_VERIFIER_ADDR = exports.API_ADDR = exports.LOCATION_ADDR = exports.BIND_ADDR = void 0;
 /*
  * Copyright (C) 2026 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -22,6 +22,22 @@ exports.TRUSTED_EDGEPORT_ADDRESSES = exports.TRUSTED_EDGEPORTS = exports.UNTRUST
  */
 const assertions_1 = require("./assertions");
 (0, assertions_1.assertOnlyOneEnvIsSet)(["CONNECT_VERIFIER_ADDR", "CONNECT_VERIFIER_PUBLIC_KEY"]);
+/**
+ * Parses an optional environment variable that must hold a positive integer.
+ *
+ * @param {string} name - The variable name, used in the error message
+ * @param {string} value - The raw value
+ * @return {number | undefined} the parsed value, or undefined when unset
+ */
+function parsePositiveInt(name, value) {
+    if (value === undefined || value.trim() === "")
+        return undefined;
+    const parsed = Number(value);
+    if (!Number.isInteger(parsed) || parsed <= 0) {
+        throw new Error(`${name} must be a positive integer, got "${value}"`);
+    }
+    return parsed;
+}
 exports.BIND_ADDR = (_a = process.env.BIND_ADDR) !== null && _a !== void 0 ? _a : "0.0.0.0:51904";
 exports.LOCATION_ADDR = process.env.LOCATION_ADDR;
 exports.API_ADDR = process.env.API_ADDR;
@@ -30,6 +46,10 @@ exports.CONNECT_VERIFIER_PUBLIC_KEY_PATH = process.env.CONNECT_VERIFIER_PUBLIC_K
 exports.CONNECT_VERIFIER_OPTIONS = process.env.CONNECT_VERIFIER_OPTIONS
     ? JSON.parse(process.env.CONNECT_VERIFIER_OPTIONS)
     : { expiresIn: "1h", algorithm: ["RS256"] };
+// Expiry, in seconds, granted to a REGISTER that carries neither a Contact
+// expires parameter nor an Expires header (RFC 3261 section 10.3, step 7).
+// Unset leaves the processor's default in place.
+exports.REGISTER_DEFAULT_EXPIRES = parsePositiveInt("REGISTER_DEFAULT_EXPIRES", process.env.REGISTER_DEFAULT_EXPIRES);
 // Platform headers a caller must never be able to set. They are removed from
 // requests that come from untrusted sources (e.g., the PSTN or a client using a
 // Connect Token) before Routr adds its own. Override with a comma-separated list;

package/dist/handlers/register.js

@@ -66,6 +66,7 @@ const location_1 = require("@routr/location");
 const processor_1 = require("@routr/processor");
 const common_1 = require("@routr/common");
 const utils_1 = require("../utils");
+const envs_1 = require("../envs");
 const logger_1 = require("@fonoster/logger");
 const logger = (0, logger_1.getLogger)({ service: "connect", filePath: __filename });
 const jwtVerifier = (0, utils_1.getVerifierImpl)();
@@ -93,10 +94,10 @@ const handleRegister = (apiClient, location) => {
             try {
                 yield location.addRoute({
                     aor: "aor" in peerOrAgent ? peerOrAgent.aor : processor_1.Target.getTargetAOR(request),
-                    route: location_1.Helper.createRoute(request),
+                    route: location_1.Helper.createRoute(request, envs_1.REGISTER_DEFAULT_EXPIRES),
                     maxContacts: peerOrAgent.maxContacts
                 });
-                res.sendRegisterOk(request);
+                res.sendRegisterOk(request, undefined, (0, utils_1.recordingMetadata)(peerOrAgent, (0, utils_1.domainOf)(peerOrAgent)));
             }
             catch (e) {
                 if (e.code === grpc.status.INVALID_ARGUMENT) {
@@ -118,7 +119,7 @@ const handleRegister = (apiClient, location) => {
                 }
                 yield location.addRoute({
                     aor: payload.aor,
-                    route: location_1.Helper.createRoute(request),
+                    route: location_1.Helper.createRoute(request, envs_1.REGISTER_DEFAULT_EXPIRES),
                     maxContacts: (_a = payload.maxContacts) !== null && _a !== void 0 ? _a : -1
                 });
                 res.sendRegisterOk(request);

package/dist/router.js

@@ -121,7 +121,11 @@ function router(location, apiClient) {
         const result = (direction, route, extended) => route
             ? {
                 direction,
-                route: Object.assign(Object.assign({}, route), { metadata: extended })
+                route: Object.assign(Object.assign({}, route), { 
+                    // Resource metadata links the call to an account; the recording
+                    // flag comes from any resource the call touches that asks for
+                    // it; trace.* keys annotate the hop in the recording
+                    metadata: Object.assign(Object.assign(Object.assign(Object.assign({}, extended), (0, utils_1.recordingMetadata)(caller, (0, utils_1.domainOf)(caller), callee, (0, utils_1.domainOf)(callee))), common_1.Trace.traceAnnotations({ direction })), route.metadata) })
             }
             : {
                 direction,
@@ -174,7 +178,7 @@ function agentToAgent(location, req) {
  */
 function fromPSTN(apiClient, location, callee, req) {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a;
+        var _a, _b;
         const sessionAffinityRef = processor_1.Extensions.getHeaderValue(req, callee.sessionAffinityHeader);
         let backend;
         const peer = (yield apiClient.peers.findBy({
@@ -198,7 +202,8 @@ function fromPSTN(apiClient, location, callee, req) {
         }
         if (!route.headers)
             route.headers = [];
-        (_a = callee.extraHeaders) === null || _a === void 0 ? void 0 : _a.forEach((prop) => {
+        route.metadata = Object.assign(Object.assign(Object.assign({}, route.metadata), (0, utils_1.recordingMetadata)(callee.trunk)), common_1.Trace.traceAnnotations({ trunk: (_a = callee.trunk) === null || _a === void 0 ? void 0 : _a.ref }));
+        (_b = callee.extraHeaders) === null || _b === void 0 ? void 0 : _b.forEach((prop) => {
             const p = {
                 name: prop.name,
                 value: prop.value,
@@ -242,6 +247,7 @@ function agentToPSTN(req, agent, calleeNumber) {
             edgePortRef: req.edgePortRef,
             listeningPoints: req.listeningPoints,
             localnets: req.localnets,
+            metadata: Object.assign(Object.assign({}, (0, utils_1.recordingMetadata)(trunk)), common_1.Trace.traceAnnotations({ trunk: trunk.ref })),
             externalAddrs: req.externalAddrs,
             headers: [
                 // TODO: Find a more deterministic way to re-add the Privacy header
@@ -280,7 +286,7 @@ function agentToPeer(location, callee, req) {
 // eslint-disable-next-line require-jsdoc
 function peerToPSTN(apiClient, req) {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a;
+        var _a, _b;
         const numberTel = processor_1.Extensions.getHeaderValue(req, common_1.CommonTypes.ExtraHeader.DOD_NUMBER);
         const privacy = processor_1.Extensions.getHeaderValue(req, common_1.CommonTypes.ExtraHeader.DOD_PRIVACY);
         if (!numberTel) {
@@ -316,6 +322,7 @@ function peerToPSTN(apiClient, req) {
             edgePortRef: req.edgePortRef,
             listeningPoints: req.listeningPoints,
             localnets: req.localnets,
+            metadata: Object.assign(Object.assign({}, (0, utils_1.recordingMetadata)(number.trunk)), common_1.Trace.traceAnnotations({ trunk: (_b = number.trunk) === null || _b === void 0 ? void 0 : _b.ref })),
             externalAddrs: req.externalAddrs,
             headers: [
                 // TODO: Find a more deterministic way to re-add the Privacy header

package/dist/service.js

@@ -101,11 +101,15 @@ const createDispatcher = (deps) => (req, res) => __awaiter(void 0, void 0, void
         (0, utils_1.isInDialog)(req)) {
         return forwardInDialog(req, res);
     }
+    // Out-of-dialog REFER (RFC 3515 allows it) would be routed as a new call below;
+    // it is refused so transfer only happens on a dialog this proxy already
+    // authorized. SIP Connect 1.1 section 12.1 keeps REFER out of scope anyway.
     switch (req.method) {
         case common_1.Method.PUBLISH:
         case common_1.Method.NOTIFY:
         case common_1.Method.SUBSCRIBE:
         case common_1.Method.MESSAGE:
+        case common_1.Method.REFER:
             res.sendMethodNotAllowed();
             break;
         case common_1.Method.REGISTER:

package/dist/utils.d.ts

@@ -74,3 +74,22 @@ export declare const getSourceAddress: (request: MessageRequest) => string | und
  * @return {boolean} true if the request comes from a trusted peer EdgePort
  */
 export declare const isFromTrustedEdgePort: (request: MessageRequest, trust: EdgePortTrust) => boolean;
+type Traceable = Pick<CC.Agent, "ref" | "trace"> | undefined | null;
+/**
+ * Metadata that asks the dispatcher to record the call when any of the
+ * resources it touches (Trunk, Agent, Peer, Domain) has `trace.enabled`.
+ * The value is the ref of the first one that asked. The dispatcher removes
+ * the key before the message leaves.
+ *
+ * @param {Traceable[]} resources - Resources the call touches, in order of precedence
+ * @return {Record<string, string>} The metadata to merge into the route
+ */
+export declare const recordingMetadata: (...resources: Traceable[]) => Record<string, string>;
+/**
+ * The domain a resource belongs to, when it carries one (Agents do).
+ *
+ * @param {object} resource - A caller or callee resource
+ * @return {CC.Domain | undefined} Its domain
+ */
+export declare const domainOf: (resource: unknown) => CC.Domain | undefined;
+export {};

package/dist/utils.js

@@ -45,7 +45,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFromTrustedEdgePort = exports.getSourceAddress = exports.getUntrustedHeadersToStrip = exports.getVerifierImpl = exports.hasXConnectObjectHeader = exports.isInDialog = exports.getSipUri = exports.getTrunkURI = exports.createTrunkAuthentication = exports.createRemotePartyId = exports.createPAssertedIdentity = exports.getRoutingDirection = exports.findResource = exports.findNumberByTelUrl = exports.findDomain = exports.isKind = void 0;
+exports.domainOf = exports.recordingMetadata = exports.isFromTrustedEdgePort = exports.getSourceAddress = exports.getUntrustedHeadersToStrip = exports.getVerifierImpl = exports.hasXConnectObjectHeader = exports.isInDialog = exports.getSipUri = exports.getTrunkURI = exports.createTrunkAuthentication = exports.createRemotePartyId = exports.createPAssertedIdentity = exports.getRoutingDirection = exports.findResource = exports.findNumberByTelUrl = exports.findDomain = exports.isKind = void 0;
 /*
  * Copyright (C) 2026 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -306,3 +306,25 @@ const isFromTrustedEdgePort = (request, trust) => {
     });
 };
 exports.isFromTrustedEdgePort = isFromTrustedEdgePort;
+/**
+ * Metadata that asks the dispatcher to record the call when any of the
+ * resources it touches (Trunk, Agent, Peer, Domain) has `trace.enabled`.
+ * The value is the ref of the first one that asked. The dispatcher removes
+ * the key before the message leaves.
+ *
+ * @param {Traceable[]} resources - Resources the call touches, in order of precedence
+ * @return {Record<string, string>} The metadata to merge into the route
+ */
+const recordingMetadata = (...resources) => {
+    const asked = resources.find((r) => { var _a; return ((_a = r === null || r === void 0 ? void 0 : r.trace) === null || _a === void 0 ? void 0 : _a.enabled) === true; });
+    return asked ? { [common_1.Trace.TRACE_FLAG_METADATA_KEY]: asked.ref } : {};
+};
+exports.recordingMetadata = recordingMetadata;
+/**
+ * The domain a resource belongs to, when it carries one (Agents do).
+ *
+ * @param {object} resource - A caller or callee resource
+ * @return {CC.Domain | undefined} Its domain
+ */
+const domainOf = (resource) => resource === null || resource === void 0 ? void 0 : resource.domain;
+exports.domainOf = domainOf;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/connect",
-  "version": "2.17.0",
+  "version": "2.19.0",
   "description": "Default processor",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -20,9 +20,9 @@
   },
   "dependencies": {
     "@fonoster/logger": "0.6.0",
-    "@routr/common": "^2.17.0",
-    "@routr/location": "^2.17.0",
-    "@routr/processor": "^2.17.0",
+    "@routr/common": "^2.19.0",
+    "@routr/location": "^2.19.0",
+    "@routr/processor": "^2.19.0",
     "jsonwebtoken": "^9.0.3"
   },
   "devDependencies": {
@@ -41,5 +41,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "9bc2d0a407a82e7b3724bb139ba62504c7b3d49e"
+  "gitHead": "357116800e150d8bbfbd0ad2406689c5793675b1"
 }