@routr/common 2.0.8-alpha.13 → 2.0.8-alpha.15

package/dist/connect/schemas/peer.d.ts

@@ -0,0 +1,68 @@
+declare const _default: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        apiVersion: {
+            enum: string[];
+        };
+        kind: {
+            enum: string[];
+        };
+        ref: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                name: {
+                    description: string;
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                username: {
+                    description: string;
+                    type: string;
+                    minLength: number;
+                    maxLength: number;
+                    readOnly: boolean;
+                };
+                aor: {
+                    description: string;
+                    type: string;
+                    minLength: number;
+                    maxLength: number;
+                };
+                contactAddr: {
+                    description: string;
+                    type: string;
+                    maxLength: number;
+                };
+                credentialsRef: {
+                    description: string;
+                    type: string;
+                };
+                accessControlListRef: {
+                    description: string;
+                    type: string;
+                };
+                enabled: {
+                    description: string;
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/peer.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * 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.default = {
+    $id: "https://json-schema.org/draft/2020-12/schema",
+    title: "Agent validation schema",
+    description: "The spec defined for Peer validation",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2.0", "v2"]
+        },
+        kind: {
+            enum: ["Peer", "peer"]
+        },
+        ref: {
+            description: "Reference to the resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string"
+                }
+            },
+            required: ["name"]
+        },
+        spec: {
+            description: "Operations spec for an Peer",
+            type: "object",
+            properties: {
+                username: {
+                    description: "The username for the Peer",
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 60,
+                    readOnly: true
+                },
+                aor: {
+                    description: "Address of the Peer (acceptable schemas are sip, backend.)",
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 255
+                },
+                contactAddr: {
+                    description: "Contact address of the Peer",
+                    type: "string",
+                    maxLength: 255
+                },
+                credentialsRef: {
+                    description: "The credential the Peer uses to authenticate",
+                    type: "string"
+                },
+                accessControlListRef: {
+                    description: "The ACL the Peer uses to control access to the Peer (Reserved for future use)",
+                    type: "string"
+                },
+                enabled: {
+                    description: "Whether the Peer is enabled",
+                    type: "boolean"
+                }
+            },
+            required: ["username"]
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

package/dist/connect/schemas/trunk.d.ts

@@ -0,0 +1,116 @@
+declare const _default: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        apiVersion: {
+            enum: string[];
+        };
+        kind: {
+            enum: string[];
+        };
+        ref: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                name: {
+                    description: string;
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                inbound: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        uri: {
+                            description: string;
+                            type: string;
+                        };
+                        accessControlListRef: {
+                            description: string;
+                            type: string;
+                        };
+                        credentialsRef: {
+                            description: string;
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+                outbound: {
+                    description: string;
+                    type: string;
+                    properties: {
+                        sendRegister: {
+                            description: string;
+                            type: string;
+                        };
+                        credentialsRef: {
+                            description: string;
+                            type: string;
+                        };
+                        uris: {
+                            description: string;
+                            type: string;
+                            items: {
+                                type: string;
+                                properties: {
+                                    uri: {
+                                        description: string;
+                                        type: string;
+                                        properties: {
+                                            host: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            port: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                            transport: {
+                                                description: string;
+                                                enum: string[];
+                                            };
+                                            user: {
+                                                description: string;
+                                                type: string;
+                                            };
+                                        };
+                                        required: string[];
+                                    };
+                                    weight: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    priority: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    enabled: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export default _default;

package/dist/connect/schemas/trunk.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * 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.default = {
+    $id: "https://json-schema.org/draft/2020-12/schema",
+    title: "Agent validation schema",
+    description: "The spec defined for Peer validation",
+    type: "object",
+    properties: {
+        apiVersion: {
+            enum: ["v2draft1", "v2.0", "v2"]
+        },
+        kind: {
+            enum: ["Trunk", "trunk"]
+        },
+        ref: {
+            description: "Reference to the resource",
+            type: "string"
+        },
+        metadata: {
+            description: "Resource metadata",
+            type: "object",
+            properties: {
+                name: {
+                    description: "Resource's friendly name",
+                    type: "string"
+                }
+            },
+            required: ["name"]
+        },
+        spec: {
+            description: "Operations spec for an Trunk",
+            type: "object",
+            properties: {
+                inbound: {
+                    description: "Inbound configuration",
+                    type: "object",
+                    properties: {
+                        uri: {
+                            description: "URI of the inbound endpoint",
+                            type: "string"
+                        },
+                        accessControlListRef: {
+                            description: "Reference to the ACL to be used for inbound traffic",
+                            type: "string"
+                        },
+                        credentialsRef: {
+                            description: "Reference to the credentials to be used for inbound traffic",
+                            type: "string"
+                        }
+                    },
+                    required: ["uri"]
+                },
+                outbound: {
+                    description: "Outbound configuration",
+                    type: "object",
+                    properties: {
+                        sendRegister: {
+                            description: "Whether to send register messages",
+                            type: "boolean"
+                        },
+                        credentialsRef: {
+                            description: "Reference to the credentials to be used for outbound traffic",
+                            type: "string"
+                        },
+                        uris: {
+                            description: "List of URIs to be used for outbound traffic",
+                            type: "array",
+                            items: {
+                                type: "object",
+                                properties: {
+                                    uri: {
+                                        description: "URI to be used for outbound traffic",
+                                        type: "object",
+                                        properties: {
+                                            host: {
+                                                description: "Hostname of the URI",
+                                                type: "string"
+                                            },
+                                            port: {
+                                                description: "Port of the URI",
+                                                type: "integer"
+                                            },
+                                            transport: {
+                                                description: "Transport of the URI",
+                                                enum: ["tcp", "sctp", "udp", "tls", "ws", "wss"]
+                                            },
+                                            user: {
+                                                description: "Username of the URI",
+                                                type: "string"
+                                            }
+                                        },
+                                        required: ["host", "port", "transport"]
+                                    },
+                                    weight: {
+                                        description: "Weight of the URI",
+                                        type: "integer"
+                                    },
+                                    priority: {
+                                        description: "Priority of the URI",
+                                        type: "integer"
+                                    },
+                                    enabled: {
+                                        description: "Whether the URI is enabled",
+                                        type: "boolean"
+                                    }
+                                },
+                                required: ["uri"]
+                            }
+                        }
+                    },
+                    required: ["uris"]
+                }
+            }
+        }
+    },
+    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+};

package/dist/connect/schemas/validators.d.ts

@@ -0,0 +1,2 @@
+declare const schemaValidators: Map<any, any>;
+export { schemaValidators };

package/dist/connect/schemas/validators.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemaValidators = void 0;
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * 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.
+ */
+const types_1 = require("../types");
+const ajv_1 = __importDefault(require("ajv"));
+const acl_1 = __importDefault(require("./acl"));
+const agent_1 = __importDefault(require("./agent"));
+const crendentials_1 = __importDefault(require("./crendentials"));
+const domain_1 = __importDefault(require("./domain"));
+const number_1 = __importDefault(require("./number"));
+const peer_1 = __importDefault(require("./peer"));
+const trunk_1 = __importDefault(require("./trunk"));
+const validator = (schema) => new ajv_1.default().compile(schema);
+const schemaValidators = new Map();
+exports.schemaValidators = schemaValidators;
+schemaValidators.set(types_1.Kind.ACL, validator(acl_1.default));
+schemaValidators.set(types_1.Kind.AGENT, validator(agent_1.default));
+schemaValidators.set(types_1.Kind.CREDENTIALS, validator(crendentials_1.default));
+schemaValidators.set(types_1.Kind.DOMAIN, validator(domain_1.default));
+schemaValidators.set(types_1.Kind.NUMBER, validator(number_1.default));
+schemaValidators.set(types_1.Kind.PEER, validator(peer_1.default));
+schemaValidators.set(types_1.Kind.TRUNK, validator(trunk_1.default));

package/dist/connect/types.d.ts

@@ -1,3 +1,4 @@
+import { JsonData, Transport } from "../types";
 export declare enum Kind {
     AGENT = "agent",
     PEER = "peer",
@@ -5,34 +6,82 @@ export declare enum Kind {
     TRUNK = "trunk",
     DOMAIN = "domain",
     UNKNOWN = "unknown",
-    CREDENTIAL = "credential",
+    CREDENTIALS = "credentials",
     ACL = "accesscontrollist"
 }
-export declare enum FindCriteria {
-    FIND_AGENT_BY_USERNAME = "find_agent_by_username",
-    FIND_PEER_BY_USERNAME = "find_peer_by_username",
-    FIND_CREDENTIAL_BY_REFERENCE = "find_credential_by_reference",
-    FIND_DOMAIN_BY_DOMAINURI = "find_domain_by_domainuri",
-    FIND_NUMBER_BY_TELURL = "find_number_by_telurl",
-    FIND_TRUNKS_WITH_SEND_REGISTER = "find_trunks_with_send_register",
-    FIND_TRUNK_BY_REQUEST_URI = "find_trunk_by_request_uri"
-}
-export interface FindParameters {
-    kind: Kind;
-    criteria: FindCriteria;
-    parameters: Record<string, string>;
-}
-export interface DataAPI {
-    get: (ref: string) => Promise<Resource>;
-    findBy: (request: FindParameters) => Promise<Resource[]>;
-}
-export interface Resource {
+export declare enum APIVersion {
+    V2DRAFT1 = "v2draft1",
+    V2 = "v2"
+}
+export interface RoutrResourceBase {
     apiVersion: string;
-    kind: Kind;
     ref: string;
-    metadata: {
+    name: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    extended?: JsonData;
+}
+export interface AccessControlList extends RoutrResourceBase {
+    allow: string[];
+    deny: string[];
+}
+export interface Domain extends RoutrResourceBase {
+    domainUri: string;
+    accessControlList: AccessControlList;
+    egressPolicies: EgressPolicy[];
+}
+export interface EgressPolicy {
+    number: INumber;
+    rule: string;
+}
+export interface Agent extends RoutrResourceBase {
+    username: string;
+    privacy: string;
+    enabled: boolean;
+    domain?: Domain;
+    credentials?: Credentials;
+}
+export interface Credentials extends RoutrResourceBase {
+    username: string;
+    password: string;
+}
+export interface INumber extends RoutrResourceBase {
+    telUrl: string;
+    aorLink: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    sessionAffinityHeader: string;
+    extraHeaders: {
         name: string;
-        region?: string;
-    };
-    spec: Record<string, any>;
+        value: string;
+    }[];
+    trunk?: Trunk;
+}
+export interface Trunk extends RoutrResourceBase {
+    sendRegister: boolean;
+    inboundUri: string;
+    accessControlList?: AccessControlList;
+    inboundCredentials?: Credentials;
+    outboundCredentials?: Credentials;
+    uris: TrunkUri[];
+}
+export interface TrunkUri {
+    host: string;
+    port: number;
+    transport: Transport;
+    user: string;
+    weight: number;
+    priority: number;
+    enabled: boolean;
+}
+export interface Peer extends RoutrResourceBase {
+    username: string;
+    aor: string;
+    contactAddr: string;
+    enabled: boolean;
+    accessControlList?: AccessControlList;
+    credentials?: Credentials;
 }
+export type RoutrResourceUnion = Agent | Peer | INumber | Trunk | Domain | Credentials | AccessControlList;
+export type RoutableResourceUnion = Agent | Peer | INumber;

package/dist/connect/types.js

@@ -1,24 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FindCriteria = exports.Kind = void 0;
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster
- *
- * 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.APIVersion = exports.Kind = void 0;
 var Kind;
 (function (Kind) {
     Kind["AGENT"] = "agent";
@@ -27,16 +9,11 @@ var Kind;
     Kind["TRUNK"] = "trunk";
     Kind["DOMAIN"] = "domain";
     Kind["UNKNOWN"] = "unknown";
-    Kind["CREDENTIAL"] = "credential";
+    Kind["CREDENTIALS"] = "credentials";
     Kind["ACL"] = "accesscontrollist";
 })(Kind = exports.Kind || (exports.Kind = {}));
-var FindCriteria;
-(function (FindCriteria) {
-    FindCriteria["FIND_AGENT_BY_USERNAME"] = "find_agent_by_username";
-    FindCriteria["FIND_PEER_BY_USERNAME"] = "find_peer_by_username";
-    FindCriteria["FIND_CREDENTIAL_BY_REFERENCE"] = "find_credential_by_reference";
-    FindCriteria["FIND_DOMAIN_BY_DOMAINURI"] = "find_domain_by_domainuri";
-    FindCriteria["FIND_NUMBER_BY_TELURL"] = "find_number_by_telurl";
-    FindCriteria["FIND_TRUNKS_WITH_SEND_REGISTER"] = "find_trunks_with_send_register";
-    FindCriteria["FIND_TRUNK_BY_REQUEST_URI"] = "find_trunk_by_request_uri";
-})(FindCriteria = exports.FindCriteria || (exports.FindCriteria = {}));
+var APIVersion;
+(function (APIVersion) {
+    APIVersion["V2DRAFT1"] = "v2draft1";
+    APIVersion["V2"] = "v2";
+})(APIVersion = exports.APIVersion || (exports.APIVersion = {}));

package/dist/errors.d.ts

@@ -1,7 +1,7 @@
 /**
  * Error thrown if the definition for a service is not found.
  */
-export declare class ServiceDefinitionNotFound extends Error {
+export declare class ServiceDefinitionNotFoundError extends Error {
     /**
      * Constructs a new ServiceDefinitionNotFound error.
      *
@@ -22,3 +22,37 @@ export declare class ServiceUnavailableError extends Error {
      */
     constructor(address: string);
 }
+/**
+ * Thrown for unimplemented handlers.
+ */
+export declare class UnimplementedError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     */
+    constructor();
+}
+/**
+ * Thrown if the resource is not found.
+ */
+export declare class ResourceNotFoundError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} ref - the reference of the resource
+     */
+    constructor(ref: string);
+}
+/**
+ * Thrown if the request is invalid.
+ */
+export declare class BadRequestError extends Error {
+    code: number;
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} message - optional message with the error. Defaults to "bad request."
+     */
+    constructor(message?: string);
+}