@fonoster/authz 0.8.0 → 0.8.4

package/README.md

@@ -18,8 +18,7 @@ type AuthzHandler = {
   checkMethodAuthorized(
     request: CheckMethodAuthorizedRequest
   ): Promise<boolean>;
-  chargeAccount(request: ChargeAccountRequest): Promise<void>;
-  getAccountBalance(request: GetAccountBalanceRequest): Promise<number>;
+  addBillingMeterEvent(request: AddBillingMeterEventRequest): Promise<void>;
 };
 ```
 
@@ -29,4 +28,4 @@ Please look at the [DummyAuthzHandler](./src/server/DummyAuthzHandler.ts) for an
 
 To enable the Authz module you need to set the `AUTHZ_SERVICE_ENABLED` environment variable to `true`. Also, you need the `AUTHZ_SERVICE_HOST` (required), `AUTHZ_SERVICE_PORT` (defaults), and `AUTHZ_SERVICE_METHODS` (default is `/fonoster.calls.v1beta2.Calls/CreateCall`) environment variables.
 
-Imagine you want to authorize the creation of new Workspaces. You can add the `/fonoster.workspaces.v1beta2.Workspaces/CreateWorkspace` method to the `AUTHZ_SERVICE_METHODS` environment variable and implement the `checkMethodAuthorized` method in your AuthzHandler.
+Imagine you want to authorize the creation of new Workspaces. You can add the `/fonoster.identity.v1beta2.Identity/CreateWorkspace` method to the `AUTHZ_SERVICE_METHODS` environment variable and implement the `checkMethodAuthorized` method in your AuthzHandler.

package/dist/client/AuthzClient.d.ts

@@ -1,4 +1,4 @@
-import { CheckMethodAuthorizedRequest, ChargeAccountRequest, GetAccountBalanceRequest, VoiceRequest } from "../types";
+import { CheckMethodAuthorizedRequest, AddBillingMeterEventRequest, VoiceRequest } from "../types";
 /**
  * AuthzClient class to interact with the AuthzServer via gRPC.
  */
@@ -14,7 +14,7 @@ export declare class AuthzClient {
      * @param request VoiceRequest containing session details.
      * @returns Promise resolving to a boolean indicating authorization.
      */
-    checkSessionAuthorized(request: VoiceRequest): Promise<boolean>;
+    checkSessionAuthorized(request: Partial<VoiceRequest>): Promise<boolean>;
     /**
      * Checks if a specific method is authorized.
      * @param request CheckMethodAuthorizedRequest containing accessKeyId and method.
@@ -22,17 +22,11 @@ export declare class AuthzClient {
      */
     checkMethodAuthorized(request: CheckMethodAuthorizedRequest): Promise<boolean>;
     /**
-     * Charges an account by a specified amount.
-     * @param request ChargeAccountRequest containing accessKeyId and amount.
+     * Adds a billing meter event.
+     * @param request AddBillingMeterEventRequest containing accessKeyId and amount.
      * @returns Promise resolving when the charge is successful.
      */
-    chargeAccount(request: ChargeAccountRequest): Promise<void>;
-    /**
-     * Retrieves the account balance.
-     * @param request GetAccountBalanceRequest containing accessKeyId.
-     * @returns Promise resolving to the account balance.
-     */
-    getAccountBalance(request: GetAccountBalanceRequest): Promise<number>;
+    addBillingMeterEvent(request: AddBillingMeterEventRequest): Promise<void>;
     /**
      * Closes the gRPC client connection.
      */

package/dist/client/AuthzClient.js

@@ -106,15 +106,15 @@ class AuthzClient {
         });
     }
     /**
-     * Charges an account by a specified amount.
-     * @param request ChargeAccountRequest containing accessKeyId and amount.
+     * Adds a billing meter event.
+     * @param request AddBillingMeterEventRequest containing accessKeyId and amount.
      * @returns Promise resolving when the charge is successful.
      */
-    async chargeAccount(request) {
+    async addBillingMeterEvent(request) {
         return new Promise((resolve, reject) => {
-            this.client.chargeAccount(request, (error, _response) => {
+            this.client.addBillingMeterEvent(request, (error, _response) => {
                 if (error) {
-                    reject(new Error(`chargeAccount failed: ${error.message || error}`));
+                    reject(new Error(`addBillingMeterEvent failed: ${error.message || error}`));
                 }
                 else {
                     resolve();
@@ -122,26 +122,6 @@ class AuthzClient {
             });
         });
     }
-    /**
-     * Retrieves the account balance.
-     * @param request GetAccountBalanceRequest containing accessKeyId.
-     * @returns Promise resolving to the account balance.
-     */
-    async getAccountBalance(request) {
-        return new Promise((resolve, reject) => {
-            this.client.getAccountBalance(request, (error, response) => {
-                if (error) {
-                    reject(new Error(`getAccountBalance failed: ${error.message || error}`));
-                }
-                else if (response && typeof response.balance === "number") {
-                    resolve(response.balance);
-                }
-                else {
-                    reject(new Error(`getAccountBalance failed: Invalid response format.`));
-                }
-            });
-        });
-    }
     /**
      * Closes the gRPC client connection.
      */

package/dist/client/AuthzServiceClient.d.ts

@@ -1,19 +1,16 @@
 import * as grpc from "@grpc/grpc-js";
-import { CheckMethodAuthorizedRequest, ChargeAccountRequest, GetAccountBalanceRequest, VoiceRequest } from "../types";
+import { CheckMethodAuthorizedRequest, VoiceRequest, AddBillingMeterEventRequest } from "../types";
 /**
  * Interface representing the AuthzService client methods.
  * This should match the service definition used by the server.
  */
 interface AuthzServiceClient extends grpc.Client {
-    checkSessionAuthorized(request: VoiceRequest, callback: grpc.requestCallback<{
+    checkSessionAuthorized(request: Partial<VoiceRequest>, callback: grpc.requestCallback<{
         authorized: boolean;
     }>): void;
     checkMethodAuthorized(request: CheckMethodAuthorizedRequest, callback: grpc.requestCallback<{
         authorized: boolean;
     }>): void;
-    chargeAccount(request: ChargeAccountRequest, callback: grpc.requestCallback<{}>): void;
-    getAccountBalance(request: GetAccountBalanceRequest, callback: grpc.requestCallback<{
-        balance: number;
-    }>): void;
+    addBillingMeterEvent(request: AddBillingMeterEventRequest, callback: grpc.requestCallback<{}>): void;
 }
 export { AuthzServiceClient };

package/dist/createCheckMethodAuthorized.js

@@ -61,11 +61,15 @@ function createCheckMethodAuthorized(authzServer, methods) {
         })
             .then(() => {
             call.sendMessage({ authorized: true }, () => {
-                logger.silly("method is authorized", { method });
+                logger.verbose("method is authorized", { method, accessKeyId });
+            });
+        })
+            .catch((error) => {
+            logger.verbose("method is not authorized", { method, accessKeyId });
+            call.sendStatus({
+                code: grpc_js_1.status.PERMISSION_DENIED,
+                details: `Method ${method} is not authorized for accessKeyId ${accessKeyId}`
             });
-        }).catch((error) => {
-            logger.error("error checking if method is authorized", { method, error });
-            call.sendStatus({ code: grpc_js_1.status.PERMISSION_DENIED, details: `Method ${method} is not authorized for accessKeyId ${accessKeyId}` });
         });
         return call;
     };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./server";
 export * from "./client";
 export * from "./createCheckMethodAuthorized";
+export * from "./types";

package/dist/index.js

@@ -35,3 +35,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./server"), exports);
 __exportStar(require("./client"), exports);
 __exportStar(require("./createCheckMethodAuthorized"), exports);
+__exportStar(require("./types"), exports);

package/dist/server/AuthzServer.d.ts

@@ -1,6 +1,7 @@
 import { ServerConfig, AuthzHandler } from "../types";
-export default class AuthzServer {
+declare class AuthzServer {
     config: ServerConfig;
     constructor(config?: ServerConfig);
     listen(handler: AuthzHandler): Promise<void>;
 }
+export { AuthzServer };

package/dist/server/AuthzServer.js

@@ -36,6 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthzServer = void 0;
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -61,6 +62,7 @@ const deepmerge_1 = __importDefault(require("deepmerge"));
 const grpc_health_check_1 = require("grpc-health-check");
 const defaultServerConfig_1 = require("./defaultServerConfig");
 const serviceDefinition_1 = require("../serviceDefinition");
+const pb_util_1 = require("pb-util");
 const logger = (0, logger_1.getLogger)({ service: "authz", filePath: __filename });
 class AuthzServer {
     constructor(config = defaultServerConfig_1.defaultServerConfig) {
@@ -118,30 +120,19 @@ class AuthzServer {
                         });
                     }
                 },
-                chargeAccount: async (call, callback) => {
-                    logger.verbose("chargeAccount called");
+                addBillingMeterEvent: async (call, callback) => {
+                    logger.verbose("addBillingMeterEvent called");
                     logger.verbose(JSON.stringify(call.request));
                     try {
-                        await handler.chargeAccount(call.request);
+                        const request = {
+                            accessKeyId: call.request.accessKeyId,
+                            payload: pb_util_1.struct.decode(call.request.payload)
+                        };
+                        await handler.addBillingMeterEvent(request);
                         callback(null, {});
                     }
                     catch (error) {
-                        logger.error("Error in chargeAccount:", error);
-                        callback({
-                            code: grpc.status.INTERNAL,
-                            message: "Internal server error."
-                        });
-                    }
-                },
-                getAccountBalance: async (call, callback) => {
-                    logger.verbose("getAccountBalance called");
-                    logger.verbose(JSON.stringify(call.request));
-                    try {
-                        const balance = await handler.getAccountBalance(call.request);
-                        callback(null, { balance });
-                    }
-                    catch (error) {
-                        logger.error("Error in getAccountBalance:", error);
+                        logger.error("Error in while adding billing meter event:", error);
                         callback({
                             code: grpc.status.INTERNAL,
                             message: "Internal server error."
@@ -165,4 +156,4 @@ class AuthzServer {
         }
     }
 }
-exports.default = AuthzServer;
+exports.AuthzServer = AuthzServer;

package/dist/server/DummyAuthzHandler.d.ts

@@ -1,8 +1,7 @@
-import { AuthzHandler, ChargeAccountRequest, CheckMethodAuthorizedRequest, GetAccountBalanceRequest, VoiceRequest } from "../types";
+import { AuthzHandler, AddBillingMeterEventRequest, CheckMethodAuthorizedRequest, VoiceRequest } from "../types";
 declare class DummyAuthzHandler implements AuthzHandler {
     checkSessionAuthorized(request: VoiceRequest): Promise<boolean>;
     checkMethodAuthorized(request: CheckMethodAuthorizedRequest): Promise<boolean>;
-    chargeAccount(request: ChargeAccountRequest): Promise<void>;
-    getAccountBalance(request: GetAccountBalanceRequest): Promise<number>;
+    addBillingMeterEvent(request: AddBillingMeterEventRequest): Promise<void>;
 }
 export { DummyAuthzHandler };

package/dist/server/DummyAuthzHandler.js

@@ -28,14 +28,10 @@ class DummyAuthzHandler {
     }
     async checkMethodAuthorized(request) {
         logger.verbose("checkMethodAuthorized called", request);
-        return false;
+        return true;
     }
-    async chargeAccount(request) {
+    async addBillingMeterEvent(request) {
         logger.verbose("chargeAccount called", request);
     }
-    async getAccountBalance(request) {
-        logger.verbose("getAccountBalance called", request);
-        return 20.2;
-    }
 }
 exports.DummyAuthzHandler = DummyAuthzHandler;

package/dist/server/server.js

@@ -1,7 +1,4 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
@@ -21,6 +18,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const AuthzServer_1 = __importDefault(require("./AuthzServer"));
+const AuthzServer_1 = require("./AuthzServer");
 const DummyAuthzHandler_1 = require("./DummyAuthzHandler");
-new AuthzServer_1.default().listen(new DummyAuthzHandler_1.DummyAuthzHandler());
+new AuthzServer_1.AuthzServer().listen(new DummyAuthzHandler_1.DummyAuthzHandler());

package/dist/types.d.ts

@@ -7,17 +7,13 @@ type CheckMethodAuthorizedRequest = {
     accessKeyId: string;
     method: string;
 };
-type ChargeAccountRequest = {
-    accessKeyId: string;
-    amount: number;
-};
-type GetAccountBalanceRequest = {
+type AddBillingMeterEventRequest = {
     accessKeyId: string;
+    payload: Record<string, unknown>;
 };
 type AuthzHandler = {
     checkSessionAuthorized(request: VoiceRequest): Promise<boolean>;
     checkMethodAuthorized(request: CheckMethodAuthorizedRequest): Promise<boolean>;
-    chargeAccount(request: ChargeAccountRequest): Promise<void>;
-    getAccountBalance(request: GetAccountBalanceRequest): Promise<number>;
+    addBillingMeterEvent(request: AddBillingMeterEventRequest): Promise<void>;
 };
-export { ServerConfig, AuthzHandler, VoiceRequest, CheckMethodAuthorizedRequest, ChargeAccountRequest, GetAccountBalanceRequest };
+export { ServerConfig, AuthzHandler, VoiceRequest, CheckMethodAuthorizedRequest, AddBillingMeterEventRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/authz",
-  "version": "0.8.0",
+  "version": "0.8.4",
   "description": "Authorization module for Fonoster",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -26,9 +26,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@fonoster/common": "^0.8.0",
-    "@fonoster/identity": "^0.8.0",
-    "@fonoster/logger": "^0.8.0",
+    "@fonoster/common": "^0.8.4",
+    "@fonoster/identity": "^0.8.4",
+    "@fonoster/logger": "^0.8.4",
     "@grpc/grpc-js": "~1.10.6",
     "deepmerge": "^4.3.1",
     "grpc-health-check": "^2.0.2"
@@ -40,5 +40,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "9d8a6fc044fe23f4f75356c142d1ca412db5af15"
+  "gitHead": "230bf0c9b793e5de49ffeb30ee1bd62226f55cba"
 }