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

package/dist/errors.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceUnavailableError = exports.ServiceDefinitionNotFound = void 0;
+exports.BadRequestError = exports.ResourceNotFoundError = exports.UnimplementedError = exports.ServiceUnavailableError = exports.ServiceDefinitionNotFoundError = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -46,7 +46,7 @@ const grpc = __importStar(require("@grpc/grpc-js"));
 /**
  * Error thrown if the definition for a service is not found.
  */
-class ServiceDefinitionNotFound extends Error {
+class ServiceDefinitionNotFoundError extends Error {
     /**
      * Constructs a new ServiceDefinitionNotFound error.
      *
@@ -54,12 +54,12 @@ class ServiceDefinitionNotFound extends Error {
      * @param {string} version - The version of the service definition.
      */
     constructor(name, version) {
-        super(`Service definition for ${name}/${version} not found`);
+        super(`service definition for ${name}/${version} not found`);
         // Set the prototype explicitly.
-        Object.setPrototypeOf(this, ServiceDefinitionNotFound.prototype);
+        Object.setPrototypeOf(this, ServiceDefinitionNotFoundError.prototype);
     }
 }
-exports.ServiceDefinitionNotFound = ServiceDefinitionNotFound;
+exports.ServiceDefinitionNotFoundError = ServiceDefinitionNotFoundError;
 /**
  * Error thrown if the service is not available.
  */
@@ -76,3 +76,49 @@ class ServiceUnavailableError extends Error {
     }
 }
 exports.ServiceUnavailableError = ServiceUnavailableError;
+/**
+ * Thrown for unimplemented handlers.
+ */
+class UnimplementedError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     */
+    constructor() {
+        super("this operation is not supported/enabled in this data api implementation.");
+        this.code = grpc.status.UNIMPLEMENTED;
+        Object.setPrototypeOf(this, UnimplementedError.prototype);
+    }
+}
+exports.UnimplementedError = UnimplementedError;
+/**
+ * Thrown if the resource is not found.
+ */
+class ResourceNotFoundError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} ref - the reference of the resource
+     */
+    constructor(ref) {
+        super(`resource not found: ${ref}`);
+        this.code = grpc.status.NOT_FOUND;
+        Object.setPrototypeOf(this, ResourceNotFoundError.prototype);
+    }
+}
+exports.ResourceNotFoundError = ResourceNotFoundError;
+/**
+ * Thrown if the request is invalid.
+ */
+class BadRequestError extends Error {
+    /**
+     * Creates an instance of UnimplementedError.
+     *
+     * @param {string} message - optional message with the error. Defaults to "bad request."
+     */
+    constructor(message) {
+        super(message !== null && message !== void 0 ? message : "bad request");
+        this.code = grpc.status.INVALID_ARGUMENT;
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/dist/helper.d.ts

@@ -26,3 +26,4 @@ export declare const getListeningPoint: (listeningPoints: NetInterface[], transp
  * @throws {Error} If the file is empty.
  */
 export declare const readConfigFile: (path: string) => Record<string, any>;
+export declare const toPascaleCase: (str: string) => string;

package/dist/helper.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readConfigFile = exports.getListeningPoint = exports.deepCopy = void 0;
+exports.toPascaleCase = exports.readConfigFile = exports.getListeningPoint = exports.deepCopy = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -45,10 +45,10 @@ exports.readConfigFile = exports.getListeningPoint = exports.deepCopy = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const types_1 = require("./types");
-const fs_1 = __importDefault(require("fs"));
 const yaml = __importStar(require("js-yaml"));
 const toml = __importStar(require("toml"));
+const fs_1 = __importDefault(require("fs"));
+const types_1 = require("./types");
 /**
  * Makes a deep copy of an object.
  *
@@ -124,3 +124,11 @@ const readConfigFile = (path) => {
     }
 };
 exports.readConfigFile = readConfigFile;
+const toPascaleCase = (str) => {
+    return str
+        .replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => {
+        return index === 0 ? word.toUpperCase() : word.toUpperCase();
+    })
+        .replace(/\s+/g, "");
+};
+exports.toPascaleCase = toPascaleCase;

package/dist/index.d.ts

@@ -1,13 +1,14 @@
-import { ServiceUnavailableError } from "./errors";
 import createService, { getObjectProto, LOCATION_OBJECT_PROTO, PROCESSOR_OBJECT_PROTO } from "./service";
 import { HeaderModifier, MessageRequest, MessageResponse, Method, NetInterface, ObjectProto, ProcessorConfig, Route, ServiceInfo, Transport } from "./types";
-export { createService, getObjectProto, HeaderModifier, Route, ServiceUnavailableError, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export { createService, getObjectProto, HeaderModifier, Route, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export * as Auth from "./auth";
 export * as Redis from "./redis";
-export * as CommonTypes from "./types";
 export * as Helper from "./helper";
 export * as IpUtils from "./ip_utils";
 export * as Tracer from "./tracer";
 export * as Assertions from "./assertions";
 export * as CommonConnect from "./connect";
 export * as CommonRequester from "./requester";
-export * as Auth from "./auth";
+export * as CommonTypes from "./types";
+export * as CommonErrors from "./errors";
+export * as ConnectSchemas from "./connect/schemas";

package/dist/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Auth = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.CommonTypes = exports.Redis = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.ServiceUnavailableError = exports.getObjectProto = exports.createService = void 0;
+exports.ConnectSchemas = exports.CommonErrors = exports.CommonTypes = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.Redis = exports.Auth = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.getObjectProto = exports.createService = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -42,8 +42,6 @@ exports.Auth = exports.CommonRequester = exports.CommonConnect = exports.Asserti
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const errors_1 = require("./errors");
-Object.defineProperty(exports, "ServiceUnavailableError", { enumerable: true, get: function () { return errors_1.ServiceUnavailableError; } });
 const service_1 = __importStar(require("./service"));
 exports.createService = service_1.default;
 Object.defineProperty(exports, "getObjectProto", { enumerable: true, get: function () { return service_1.getObjectProto; } });
@@ -52,12 +50,14 @@ Object.defineProperty(exports, "PROCESSOR_OBJECT_PROTO", { enumerable: true, get
 const types_1 = require("./types");
 Object.defineProperty(exports, "Method", { enumerable: true, get: function () { return types_1.Method; } });
 Object.defineProperty(exports, "Transport", { enumerable: true, get: function () { return types_1.Transport; } });
+exports.Auth = __importStar(require("./auth"));
 exports.Redis = __importStar(require("./redis"));
-exports.CommonTypes = __importStar(require("./types"));
 exports.Helper = __importStar(require("./helper"));
 exports.IpUtils = __importStar(require("./ip_utils"));
 exports.Tracer = __importStar(require("./tracer"));
 exports.Assertions = __importStar(require("./assertions"));
 exports.CommonConnect = __importStar(require("./connect"));
 exports.CommonRequester = __importStar(require("./requester"));
-exports.Auth = __importStar(require("./auth"));
+exports.CommonTypes = __importStar(require("./types"));
+exports.CommonErrors = __importStar(require("./errors"));
+exports.ConnectSchemas = __importStar(require("./connect/schemas"));

package/dist/protos/common.proto

@@ -33,5 +33,3 @@ enum Transport {
   WS = 4;
   WSS = 5;
 }
-
-message Empty {}

package/dist/protos/location.proto

@@ -25,13 +25,14 @@ option java_package = "io.routr.location";
 option java_outer_classname = "LocationProto";
 option objc_class_prefix = "LC";
 
+import "google/protobuf/empty.proto";
 import "common.proto";
 import "processor.proto";
 
 service Location {
-  rpc AddRoute (AddRouteRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+  rpc AddRoute (AddRouteRequest) returns (.google.protobuf.Empty) {}
   rpc FindRoutes (FindRoutesRequest) returns (FindRoutesResponse) {}
-  rpc RemoveRoutes (RemoveRoutesRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
+  rpc RemoveRoutes (RemoveRoutesRequest) returns (.google.protobuf.Empty) {}
 }
 
 // A binding created by an actual endpoint (Softphone, PBX, Conference System, etc.)

package/dist/service.d.ts

@@ -1,5 +1,5 @@
 import { ObjectProto, ServiceInfo } from "./types";
-import { ServiceDefinitionNotFound } from "./errors";
+import { ServiceDefinitionNotFoundError } from "./errors";
 export declare const PROCESSOR_OBJECT_PROTO: unknown;
 export declare const LOCATION_OBJECT_PROTO: unknown;
 /**
@@ -8,7 +8,7 @@ export declare const LOCATION_OBJECT_PROTO: unknown;
  * @param {ObjectProt} objectProto - The object proto to load.
  * @return {A} The proto definition.
  */
-export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFound;
+export declare function getObjectProto<A>(objectProto: ObjectProto): A | ServiceDefinitionNotFoundError;
 /**
  * Creates a new service using the given service definition.
  *

package/dist/service.js

@@ -62,7 +62,7 @@ function getObjectProto(objectProto) {
     const objProto = (_b = (_a = grpc.loadPackageDefinition(definitions)) === null || _a === void 0 ? void 0 : _a.fonoster) === null || _b === void 0 ? void 0 : _b.routr[objectProto.name];
     return (objProto === null || objProto === void 0 ? void 0 : objProto[objectProto.version])
         ? objProto[objectProto.version]
-        : new errors_1.ServiceDefinitionNotFound(objectProto.name, objectProto.version);
+        : new errors_1.ServiceDefinitionNotFoundError(objectProto.name, objectProto.version);
 }
 exports.getObjectProto = getObjectProto;
 /**

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 import { ServiceDefinition } from "@grpc/proto-loader";
+import { JsonArray, JsonValue, Struct } from "pb-util/build";
+export type JsonData = Record<string, string | number | boolean | JsonValue | JsonArray | Struct>;
 export declare enum Method {
     UNKNOWN = "UNKNOWN",
     REGISTER = "REGISTER",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.13",
+  "version": "2.0.8-alpha.15",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -10,7 +10,7 @@
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
     "build": "tsc -b tsconfig.json",
-    "postbuild": "mkdir -p dist/protos && cp src/protos/* dist/protos"
+    "postbuild": "cp -a src/protos dist/protos && cp -a src/connect/protos dist/connect/protos"
   },
   "dependencies": {
     "@fonoster/logger": "0.3.18",
@@ -50,5 +50,5 @@
   "devDependencies": {
     "@types/js-yaml": "^4.0.5"
   },
-  "gitHead": "d866d6c03c5ea7e8fc3ee074804005df3a5be42f"
+  "gitHead": "713d176551252a157b5a7693ef8dba4e3e798dea"
 }

package/dist/connect/data_api.d.ts

@@ -1,11 +0,0 @@
-import { FindParameters, Resource } from "./types";
-/**
- * Data API for the Connect module.
- *
- * @param {string} apiAddr - The address of the API server
- * @return {Promise<Resource[]>}
- */
-export declare function dataAPI(apiAddr: string): {
-    get: (ref: string) => Promise<Resource>;
-    findBy: (request: FindParameters) => Promise<Resource[]>;
-};

package/dist/connect/data_api.js

@@ -1,91 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataAPI = 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.
- */
-const grpc = __importStar(require("@grpc/grpc-js"));
-const protobufUtil = __importStar(require("pb-util"));
-const errors_1 = require("../errors");
-const grpc_client_1 = require("./grpc_client");
-const jsonToStruct = protobufUtil.struct.encode;
-const jsonFromStruct = protobufUtil.struct.decode;
-/**
- * Data API for the Connect module.
- *
- * @param {string} apiAddr - The address of the API server
- * @return {Promise<Resource[]>}
- */
-function dataAPI(apiAddr) {
-    const client = new grpc_client_1.RESOURCES_PROTO.v2draft1.Resources(apiAddr, grpc.credentials.createInsecure());
-    return {
-        get: (ref) => new Promise((resolve, reject) => {
-            client.get({ ref }, (err, response) => {
-                if (err) {
-                    return err.code === grpc.status.UNAVAILABLE
-                        ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
-                        : reject(err);
-                }
-                // Convert back to Json
-                response.spec = jsonFromStruct(response.spec);
-                resolve(response);
-            });
-        }),
-        findBy: (request) => new Promise((resolve, reject) => {
-            request.parameters = jsonToStruct(request.parameters);
-            client.findBy(request, (err, response) => {
-                var _a;
-                if (err) {
-                    return err.code === grpc.status.UNAVAILABLE
-                        ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
-                        : reject(err);
-                }
-                const res = (_a = response === null || response === void 0 ? void 0 : response.resources) === null || _a === void 0 ? void 0 : _a.map((resource) => {
-                    // Convert back to Json
-                    resource.spec = jsonFromStruct(resource.spec);
-                    return resource;
-                });
-                resolve(res);
-            });
-        })
-    };
-}
-exports.dataAPI = dataAPI;

package/dist/protos/resources.proto

@@ -1,108 +0,0 @@
-// TODO: Show a link to were this proto was downloaded from
-syntax = "proto3";
-
-package fonoster.routr.resources.v2draft1;
-
-import "google/protobuf/struct.proto";
-
-// Resources service
-service Resources {
-  rpc Create (CreateRequest) returns (Resource) {}
-  rpc Update (UpdateRequest) returns (Resource) {}
-  rpc Get (GetRequest) returns (Resource) {}
-  rpc Delete (DeleteRequest) returns (Empty) {}
-  rpc List (ListRequest) returns (ListResponse) {}
-  rpc FindBy (FindByRequest) returns (FindByResponse) {}
-}
-
-message Metadata {
-  // The resource's name
-  string name = 1;
-  // Created at
-  int32 create_time = 2;
-  // Updated at
-  int32 update_time = 3;
-}
-
-message Resource {
-  // The resource's api version
-  string apiVersion = 1;
-  // The resource's kind
-  string kind = 2;
-  // The resource's unique identifier
-  string ref = 3;
-  // The resource's metadata
-  Metadata metadata = 4;
-  // The resource's data
-  .google.protobuf.Struct spec = 5;
-}
-
-message CreateRequest  {
-  Metadata metadata = 1;
-  .google.protobuf.Struct spec = 2;
-}
-
-message UpdateRequest  {
-  Metadata metadata = 1;
-  .google.protobuf.Struct spec = 2;
-}
-
-message DeleteRequest  {
-  string ref = 1;
-}
-
-message GetRequest  {
-  string ref = 1;
-}
-
-message ListRequest {
-  // The maximum number of items in the list
-  int32 page_size = 1;
-
-  // The next_page_token value returned from the previous request, if any
-  string page_token = 2;
-
-  // The filter to apply to the list
-  string filter = 3;
-
-  // The type of resource to list
-  string kind = 4;
-
-  // Level of detail of the individual entities (reserved)
-  View view = 5;
-}
-
-message ListResponse {
-  // List of Resources
-  repeated Resource resources = 1;
-
-  // Token to retrieve the next page of results, or empty if there are no more results in the list
-  string next_page_token = 2;
-}
-
-message FindByRequest {
-  // The type of resource to find
-  string kind = 1;
-
-  // Search criteria for the request
-  string criteria = 2;
-
-  // Parameters to apply in combination with the search criteria
-  .google.protobuf.Struct parameters = 3; 
-
-  // Level of detail of the individual entities (reserved)
-  View view = 4;
-}
-
-message FindByResponse {
-  // List of Resources
-  repeated Resource resources = 1;
-}
-
-enum View {
-  BASIC = 0;
-  STANDARD = 1;
-  FULL = 2;
-}
-
-message Empty {}