@meshtrade/api-web 1.30.2 → 1.31.0

package/dist/meshtrade/wallet/account/v1/service_web_meshts.js

@@ -7,28 +7,87 @@ exports.AccountServiceWeb = void 0;
 const connect_1 = require("@connectrpc/connect");
 const connect_web_1 = require("@connectrpc/connect-web");
 const service_pb_1 = require("./service_pb");
-const config_1 = require("../../../common/config");
-const validation_1 = require("../../../common/validation");
-const connectInterceptors_1 = require("../../../common/connectInterceptors");
+const service_pb_2 = require("./service_pb");
+const config_1 = require("../../../config");
+const protovalidate_1 = require("@bufbuild/protovalidate");
+const interceptors_1 = require("../../../interceptors");
 /**
  * Web client for interacting with the meshtrade.wallet.account.v1 account v1 API resource service.
- * Uses Connect-ES with gRPC-Web transport for browser-compatible gRPC communication.
+ * Uses Connect-ES with gRPC-Web transport for browser-based communication.
+ *
+ * Supports flexible authentication modes using functional options pattern:
+ *
+ * 1. **No Authentication** (public APIs):
+ *    ```typescript
+ *    const client = new AccountServiceWeb(
+ *      WithServerUrl("http://localhost:10000")
+ *    );
+ *    ```
+ *
+ * 2. **API Key Authentication** (backend services):
+ *    ```typescript
+ *    const client = new AccountServiceWeb(
+ *      WithAPIKey("your-api-key"),
+ *      WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
+ *      WithServerUrl("https://api.example.com")
+ *    );
+ *    ```
+ *
+ * 3. **JWT Token Authentication** (Next.js frontend with user session):
+ *    ```typescript
+ *    const client = new AccountServiceWeb(
+ *      WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
+ *      WithServerUrl("https://api.example.com")
+ *    );
+ *    ```
+ *
+ * 4. **JWT with Group Context** (user session with specific group):
+ *    ```typescript
+ *    const client = new AccountServiceWeb(
+ *      WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
+ *      WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
+ *      WithServerUrl("https://api.example.com")
+ *    );
+ *    ```
+ *
+ * Available options:
+ * - `WithAPIKey(key)` - API key authentication (mutually exclusive with JWT)
+ * - `WithJWTAccessToken(token)` - JWT authentication (mutually exclusive with API key)
+ * - `WithGroup(group)` - Group context (optional, works with both auth modes)
+ * - `WithServerUrl(url)` - Custom server URL (optional, defaults to production)
  */
 class AccountServiceWeb {
     /**
      * Constructs an instance of AccountServiceWeb.
-     * @param {ConfigOpts} [config] - Optional configuration for the client.
-     * @param {Interceptor[]} [interceptors] - For internal use by `withGroup`.
+     *
+     * Uses functional options pattern for flexible configuration:
+     * - `WithAPIKey(key)` - API key authentication
+     * - `WithJWTAccessToken(token)` - JWT authentication
+     * - `WithGroup(group)` - Group context (optional)
+     * - `WithServerUrl(url)` - Custom server URL (optional)
+     *
+     * @param {...ClientOption} opts - Variable number of configuration options
      */
-    constructor(config, interceptors) {
-        this._config = (0, config_1.getConfigFromOpts)(config);
-        this._interceptors = interceptors || [];
-        // Create the gRPC-Web transport with interceptors
+    constructor(...opts) {
+        // Build configuration from options
+        this._config = (0, config_1.buildConfigFromOptions)(...opts);
+        // Initialize validator for request validation
+        this._validator = (0, protovalidate_1.createValidator)();
+        this._interceptors = [];
+        this._interceptors.push((0, interceptors_1.createLoggingInterceptor)());
+        if (this._config.apiKey) {
+            this._interceptors.push((0, interceptors_1.createApiKeyInterceptor)(this._config.apiKey));
+        }
+        if (this._config.jwtToken) {
+            this._interceptors.push((0, interceptors_1.createJwtInterceptor)(this._config.jwtToken));
+        }
+        if (this._config.group) {
+            this._interceptors.push((0, interceptors_1.createGroupInterceptor)(this._config.group));
+        }
+        // Create the gRPC-Web transport for browser with interceptors
         const transport = (0, connect_web_1.createGrpcWebTransport)({
             baseUrl: this._config.apiServerURL,
             interceptors: this._interceptors,
-            // Enable credentials (cookies) for cross-origin requests
-            fetch: (input, init) => globalThis.fetch(input, { ...init, credentials: 'include' }),
         });
         // Construct the Connect-ES client
         this._client = (0, connect_1.createClient)(service_pb_1.AccountService, transport);
@@ -37,26 +96,36 @@ class AccountServiceWeb {
      * Returns a new client instance configured to send the specified group
      * resource name in the request headers for subsequent API calls.
      *
+     * This method creates a new client with the same authentication configuration
+     * but with the group context updated to the specified value.
+     *
+     * **Compatibility**: Works with all authentication modes:
+     * - **API key auth**: Creates new client with API key + new group
+     * - **JWT auth**: Creates new client with JWT + new group
+     * - **No auth**: Creates new client with standalone group interceptor
+     *
      * @param {string} group - The operating group context to inject into the request
      *                         in the format `groups/{ulid}` where {ulid} is a 26-character ULID.
      *                         Example: 'groups/01ARZ3NDEKTSV4YWVF8F5BH32'
      * @returns {AccountServiceWeb} A new, configured instance of the client.
-     * @throws {Error} If the group format is invalid (validation occurs in createGroupInterceptor)
+     * @throws {Error} If the group format is invalid
      */
     withGroup(group) {
-        // Check if a group interceptor already exists.
-        // Group interceptors are identified by having a 'groupContext' property
-        const hasGroupInterceptor = this._interceptors.some((interceptor) => interceptor.groupContext !== undefined);
-        if (hasGroupInterceptor) {
-            throw new Error("Attempted to set group context twice. A group has already been set for this client instance.");
-        }
-        // Create a new interceptor for the group context
-        const groupInterceptor = (0, connectInterceptors_1.createGroupInterceptor)(group);
-        // Return a new client instance with the existing interceptors plus the new one
-        return new AccountServiceWeb(this._config, [
-            ...this._interceptors,
-            groupInterceptor,
-        ]);
+        // Build new options array with existing auth and updated group
+        const newOpts = [];
+        // Add server URL
+        newOpts.push((0, config_1.WithServerUrl)(this._config.apiServerURL));
+        // Add authentication (preserve existing mode)
+        if (this._config.apiKey) {
+            newOpts.push((0, config_1.WithAPIKey)(this._config.apiKey));
+        }
+        else if (this._config.jwtToken) {
+            newOpts.push((0, config_1.WithJWTAccessToken)(this._config.jwtToken));
+        }
+        // Add the new group
+        newOpts.push((0, config_1.WithGroup)(group));
+        // Return a new client instance with updated configuration
+        return new AccountServiceWeb(...newOpts);
     }
     /**
      * Creates a new account.
@@ -65,7 +134,14 @@ class AccountServiceWeb {
      */
     createAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.CreateAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.createAccount(request);
     }
     /**
@@ -75,7 +151,14 @@ class AccountServiceWeb {
      */
     updateAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.UpdateAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.updateAccount(request);
     }
     /**
@@ -85,7 +168,14 @@ class AccountServiceWeb {
      */
     openAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.OpenAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.openAccount(request);
     }
     /**
@@ -95,7 +185,14 @@ class AccountServiceWeb {
      */
     addSignatoriesToAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.AddSignatoriesToAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.addSignatoriesToAccount(request);
     }
     /**
@@ -105,7 +202,14 @@ class AccountServiceWeb {
      */
     removeSignatoriesFromAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.RemoveSignatoriesFromAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.removeSignatoriesFromAccount(request);
     }
     /**
@@ -115,7 +219,14 @@ class AccountServiceWeb {
      */
     getAccount(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.GetAccountRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.getAccount(request);
     }
     /**
@@ -125,7 +236,14 @@ class AccountServiceWeb {
      */
     getAccountByNumber(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.GetAccountByNumberRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.getAccountByNumber(request);
     }
     /**
@@ -135,7 +253,14 @@ class AccountServiceWeb {
      */
     listAccounts(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.ListAccountsRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.listAccounts(request);
     }
     /**
@@ -145,7 +270,14 @@ class AccountServiceWeb {
      */
     searchAccounts(request) {
         // Validate request
-        (0, validation_1.validateRequest)(request);
+        const result = this._validator.validate(service_pb_2.SearchAccountsRequestSchema, request);
+        if (result.kind === "invalid") {
+            const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
+            throw new Error(`Validation failed: ${violations}`);
+        }
+        else if (result.kind === "error") {
+            throw result.error;
+        }
         return this._client.searchAccounts(request);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshtrade/api-web",
-  "version": "1.30.2",
+  "version": "1.31.0",
   "description": "Mesh Typescript SDK",
   "author": "Bernard Bussy <bernard@meshtrade.co>",
   "license": "UNLICENSED",
@@ -81,6 +81,16 @@
       "require": "./dist/meshtrade/option/v1/index.js",
       "import": "./dist/meshtrade/option/v1/index.js"
     },
+    "./config": {
+      "types": "./dist/meshtrade/config/index.d.ts",
+      "require": "./dist/meshtrade/config/index.js",
+      "import": "./dist/meshtrade/config/index.js"
+    },
+    "./interceptors": {
+      "types": "./dist/meshtrade/interceptors/index.d.ts",
+      "require": "./dist/meshtrade/interceptors/index.js",
+      "import": "./dist/meshtrade/interceptors/index.js"
+    },
     "./*": {
       "types": "./dist/meshtrade/*",
       "require": "./dist/meshtrade/*",
@@ -128,6 +138,12 @@
       "option/v1": [
         "dist/meshtrade/option/v1/index.d.ts"
       ],
+      "config": [
+        "dist/meshtrade/config/index.d.ts"
+      ],
+      "interceptors": [
+        "dist/meshtrade/interceptors/index.d.ts"
+      ],
       "*": [
         "dist/meshtrade/*"
       ]
@@ -138,6 +154,7 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.10.1",
+    "@bufbuild/protovalidate": "^1.0.0",
     "@connectrpc/connect": "^2.1.0",
     "@connectrpc/connect-web": "^2.1.0",
     "bignumber.js": "^9.3.0"
@@ -159,7 +176,7 @@
   },
   "scripts": {
     "clean": "rimraf ./dist",
-    "build:ts": "tsc",
+    "build:ts": "tsc --project tsconfig.build.json",
     "build": "yarn run clean && yarn run build:ts",
     "lint": "eslint . --ext .ts",
     "test": "jest"

package/dist/meshtrade/common/config.d.ts

@@ -1,7 +0,0 @@
-export type ConfigOpts = {
-    apiServerURL?: string;
-};
-export type Config = {
-    apiServerURL: string;
-};
-export declare function getConfigFromOpts(config?: ConfigOpts): Config;

package/dist/meshtrade/common/config.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfigFromOpts = getConfigFromOpts;
-function getConfigFromOpts(config) {
-    const apiServerURL = config?.apiServerURL ?? "http://localhost:10000";
-    return {
-        apiServerURL,
-    };
-}

package/dist/meshtrade/common/validation.d.ts

@@ -1,62 +0,0 @@
-/**
- * Generic validation utilities for Meshtrade API resource names and identifiers.
- */
-/**
- * Validates if a string is a valid ULID (Universally Unique Lexicographically Sortable Identifier).
- *
- * Note: This implementation uses a simplified character set for ULIDs that includes
- * all uppercase letters A-Z and digits 0-9, unlike the standard ULID specification
- * which excludes certain ambiguous characters (I, L, O, U).
- *
- * ULIDs in this system are 26-character identifiers that are:
- * - Lexicographically sortable
- * - Uppercase alphanumeric only
- * - Contain timestamp information for natural ordering
- *
- * @param ulid - The string to validate as a ULID
- * @returns true if the string is a valid ULID format, false otherwise
- *
- * @example
- * ```typescript
- * isValidULID('01ARZ3NDEKTSV4YWVF8F5BH32'); // true
- * isValidULID('invalid'); // false
- * isValidULID('01arz3ndektsv4ywvf8f5bh32'); // false (lowercase)
- * ```
- */
-export declare function isValidULID(ulid: string): boolean;
-/**
- * Validates if a resource name follows the groups/{ulid} format.
- *
- * Group resource names in the Meshtrade API follow the pattern "groups/{ulid}"
- * where {ulid} is a 26-character ULID identifier.
- *
- * @param resourceName - The resource name string to validate
- * @returns true if the resource name is a valid group resource name, false otherwise
- *
- * @example
- * ```typescript
- * isValidGroupResourceName('groups/01ARZ3NDEKTSV4YWVF8F5BH32'); // true
- * isValidGroupResourceName('groups/invalid'); // false
- * isValidGroupResourceName('users/01ARZ3NDEKTSV4YWVF8F5BH32'); // false
- * isValidGroupResourceName('01ARZ3NDEKTSV4YWVF8F5BH32'); // false
- * ```
- */
-export declare function isValidGroupResourceName(resourceName: string): boolean;
-/**
- * Validates a protobuf request message before sending to the server.
- *
- * This function serves as a client-side validation hook that can be extended
- * to include protovalidate integration or other validation logic.
- *
- * Currently performs basic null/undefined checks. Future enhancements may include
- * protovalidate integration for comprehensive message validation.
- *
- * @param request - The protobuf request message to validate
- * @throws {Error} If the request is null or undefined
- *
- * @example
- * ```typescript
- * validateRequest(myRequest); // Throws if request is invalid
- * ```
- */
-export declare function validateRequest(request: unknown): void;

package/dist/meshtrade/common/validation.js

@@ -1,77 +0,0 @@
-"use strict";
-/**
- * Generic validation utilities for Meshtrade API resource names and identifiers.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidULID = isValidULID;
-exports.isValidGroupResourceName = isValidGroupResourceName;
-exports.validateRequest = validateRequest;
-/**
- * Validates if a string is a valid ULID (Universally Unique Lexicographically Sortable Identifier).
- *
- * Note: This implementation uses a simplified character set for ULIDs that includes
- * all uppercase letters A-Z and digits 0-9, unlike the standard ULID specification
- * which excludes certain ambiguous characters (I, L, O, U).
- *
- * ULIDs in this system are 26-character identifiers that are:
- * - Lexicographically sortable
- * - Uppercase alphanumeric only
- * - Contain timestamp information for natural ordering
- *
- * @param ulid - The string to validate as a ULID
- * @returns true if the string is a valid ULID format, false otherwise
- *
- * @example
- * ```typescript
- * isValidULID('01ARZ3NDEKTSV4YWVF8F5BH32'); // true
- * isValidULID('invalid'); // false
- * isValidULID('01arz3ndektsv4ywvf8f5bh32'); // false (lowercase)
- * ```
- */
-function isValidULID(ulid) {
-    return /^[0-9A-Z]{26}$/.test(ulid);
-}
-/**
- * Validates if a resource name follows the groups/{ulid} format.
- *
- * Group resource names in the Meshtrade API follow the pattern "groups/{ulid}"
- * where {ulid} is a 26-character ULID identifier.
- *
- * @param resourceName - The resource name string to validate
- * @returns true if the resource name is a valid group resource name, false otherwise
- *
- * @example
- * ```typescript
- * isValidGroupResourceName('groups/01ARZ3NDEKTSV4YWVF8F5BH32'); // true
- * isValidGroupResourceName('groups/invalid'); // false
- * isValidGroupResourceName('users/01ARZ3NDEKTSV4YWVF8F5BH32'); // false
- * isValidGroupResourceName('01ARZ3NDEKTSV4YWVF8F5BH32'); // false
- * ```
- */
-function isValidGroupResourceName(resourceName) {
-    return /^groups\/[0-9A-Z]{26}$/.test(resourceName);
-}
-/**
- * Validates a protobuf request message before sending to the server.
- *
- * This function serves as a client-side validation hook that can be extended
- * to include protovalidate integration or other validation logic.
- *
- * Currently performs basic null/undefined checks. Future enhancements may include
- * protovalidate integration for comprehensive message validation.
- *
- * @param request - The protobuf request message to validate
- * @throws {Error} If the request is null or undefined
- *
- * @example
- * ```typescript
- * validateRequest(myRequest); // Throws if request is invalid
- * ```
- */
-function validateRequest(request) {
-    if (request === null || request === undefined) {
-        throw new Error("Request cannot be null or undefined");
-    }
-    // Future: Integrate protovalidate for comprehensive message validation
-    // For now, basic validation is sufficient as the server also validates
-}