@itwin/access-control-client 3.6.0 → 4.0.0

package/lib/cjs/accessControlClientInterfaces/UserMembersClient.d.ts

@@ -0,0 +1,16 @@
+import type { AccessToken } from "@itwin/core-bentley";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from "../types/UserMembers";
+export interface IUserMembersClient {
+    /** Retrieves a list of user members and their roles assigned to a specified iTwin. */
+    queryITwinUserMembers(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleUserMembersResponse>>;
+    /** Retrieves a specific user member for a specified iTwin. */
+    getITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
+    /** Add or invite new iTwin user members */
+    addITwinUserMembers(accessToken: AccessToken, iTwinId: string, newMembers: AddUserMember[], customMessage?: string): Promise<BentleyAPIResponse<AddUserMemberResponse>>;
+    /**  Remove the specified iTwin user member */
+    removeITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<BentleyAPIResponse<undefined>>;
+    /**  Update iTwin user member roles */
+    updateITwinUserMember(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;
+}
+//# sourceMappingURL=UserMembersClient.d.ts.map

package/lib/cjs/accessControlClientInterfaces/UserMembersClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembersClient.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/UserMembersClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAGxI,MAAM,WAAW,kBAAkB;IACjC,sFAAsF;IACtF,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAE5D,8DAA8D;IAC9D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAA;IAExD,2CAA2C;IAC3C,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,aAAa,EAAE,EAC3B,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEtD,8CAA8C;IAC9C,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,sCAAsC;IACtC,qBAAqB,CACnB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;CAC1D"}

package/lib/cjs/accessControlClientInterfaces/UserMembersClient.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=UserMembersClient.js.map

package/lib/cjs/accessControlClientInterfaces/UserMembersClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserMembersClient.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/UserMembersClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { AddUserMember, AddUserMemberResponse, MultipleUserMembersResponse, SingleUserMemberResponse } from \"../types/UserMembers\";\n\n\nexport interface IUserMembersClient {\n  /** Retrieves a list of user members and their roles assigned to a specified iTwin. */\n  queryITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleUserMembersResponse>>;\n\n  /** Retrieves a specific user member for a specified iTwin. */\n  getITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>>\n\n  /** Add or invite new iTwin user members */\n  addITwinUserMembers(\n    accessToken: AccessToken,\n    iTwinId: string,\n    newMembers: AddUserMember[],\n    customMessage?: string\n  ): Promise<BentleyAPIResponse<AddUserMemberResponse>>;\n\n  /**  Remove the specified iTwin user member */\n  removeITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string\n  ): Promise<BentleyAPIResponse<undefined>>;\n\n  /**  Update iTwin user member roles */\n  updateITwinUserMember(\n    accessToken: AccessToken,\n    iTwinId: string,\n    memberId: string,\n    roleIds: string[]\n  ): Promise<BentleyAPIResponse<SingleUserMemberResponse>>;\n}\n"]}

package/lib/cjs/accessControlClientInterfaces/accessControl.d.ts

@@ -0,0 +1,23 @@
+import type { IGroupsClient } from "./GroupClient";
+import type { IGroupMemberInvitationClient } from "./GroupMemberInvitationClient";
+import type { IGroupMembersClient } from "./GroupMembersClient";
+import type { IITwinJobsClient } from "./ITwinJobsClient";
+import type { IITwinSharesClient } from "./ItwinSharesClient";
+import type { IMemberInvitationsClient } from "./MemberInvitationsClient";
+import type { IOwnerMembersClient } from "./OwnerMembersClient ";
+import type { IPermissionsClient } from "./PermissionsClient";
+import type { IRolesClient } from "./RolesClient";
+import type { IUserMembersClient } from "./UserMembersClient";
+export interface IAccessControlClient {
+    permissions: IPermissionsClient;
+    roles: IRolesClient;
+    groups: IGroupsClient;
+    userMembers: IUserMembersClient;
+    groupMembers: IGroupMembersClient;
+    ownerMembers: IOwnerMembersClient;
+    memberInvitations: IMemberInvitationsClient;
+    itwinJobs: IITwinJobsClient;
+    itwinShares: IITwinSharesClient;
+    groupMemberInvitations: IGroupMemberInvitationClient;
+}
+//# sourceMappingURL=accessControl.d.ts.map

package/lib/cjs/accessControlClientInterfaces/accessControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControl.d.ts","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/accessControl.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,YAAY,EAAE,mBAAmB,CAAC;IAClC,YAAY,EAAE,mBAAmB,CAAC;IAClC,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,SAAS,EAAE,gBAAgB,CAAC;IAC5B,WAAW,EAAE,kBAAkB,CAAC;IAChC,sBAAsB,EAAE,4BAA4B,CAAA;CACrD"}

package/lib/cjs/accessControlClientInterfaces/accessControl.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accessControl.js.map

package/lib/cjs/accessControlClientInterfaces/accessControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControl.js","sourceRoot":"","sources":["../../../src/accessControlClientInterfaces/accessControl.ts"],"names":[],"mappings":";AAAA;;;gGAGgG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport type { IGroupsClient } from \"./GroupClient\";\nimport type { IGroupMemberInvitationClient } from \"./GroupMemberInvitationClient\";\nimport type { IGroupMembersClient } from \"./GroupMembersClient\";\nimport type { IITwinJobsClient } from \"./ITwinJobsClient\";\nimport type { IITwinSharesClient } from \"./ItwinSharesClient\";\nimport type { IMemberInvitationsClient } from \"./MemberInvitationsClient\";\nimport type { IOwnerMembersClient } from \"./OwnerMembersClient \";\nimport type { IPermissionsClient } from \"./PermissionsClient\";\nimport type { IRolesClient } from \"./RolesClient\";\nimport type { IUserMembersClient } from \"./UserMembersClient\";\n\nexport interface IAccessControlClient {\n  permissions: IPermissionsClient;\n  roles: IRolesClient;\n  groups: IGroupsClient;\n  userMembers: IUserMembersClient;\n  groupMembers: IGroupMembersClient;\n  ownerMembers: IOwnerMembersClient;\n  memberInvitations: IMemberInvitationsClient;\n  itwinJobs: IITwinJobsClient;\n  itwinShares: IITwinSharesClient;\n  groupMemberInvitations: IGroupMemberInvitationClient\n}\n"]}

package/lib/cjs/subClients/BaseClient.d.ts

@@ -2,33 +2,99 @@
  * @module AccessControlClient
  */
 import type { AccessToken } from "@itwin/core-bentley";
-import type { Method } from "axios";
-import type { AxiosRequestConfig } from "axios";
-import type { AccessControlAPIResponse, AccessControlQueryArg } from "../accessControlTypes";
+import type { BentleyAPIResponse, Method, ODataQueryParams, RequestConfig } from "../types/CommonApiTypes";
+import { ParameterMapping } from "../types/typeUtils";
+/**
+ * Base client class providing common functionality for Access Control API requests.
+ * Handles authentication, request configuration, and query string building, and error validation.
+ */
 export declare class BaseClient {
     protected _baseUrl: string;
+    /**
+   * Creates a new BaseClient instance for Access Control API operations
+   * @param url - Optional custom base URL, defaults to production iTwins API URL
+   *
+   * @example
+   * ```typescript
+   * // Use default production URL
+   * const client = new BaseClient();
+   *
+   * // Use custom URL for development/testing
+   * const client = new ITwinsAccessClient("https://api.bentley.com/accesscontrol/itwins");
+   * ```
+   */
     constructor(url?: string);
     /**
-      * Sends a basic API request
-      * @param accessTokenString The client access token string
-      * @param method The method type of the request (ex. GET, POST, DELETE, etc)
-      * @param url The url of the request
-      */
-    protected sendGenericAPIRequest(accessToken: AccessToken, method: Method, url: string, data?: any, property?: string, additionalHeaders?: {
-        [key: string]: string;
-    }): Promise<AccessControlAPIResponse<any>>;
+     * Maps the some properties of {@link ODataQueryParams} to their corresponding query parameter names.
+     *
+     * @remarks
+     * This mapping is used to translate internal property names to the expected parameter names
+     * when constructing requests. Properties mapped to empty strings are excluded from
+     * the query string as they should be sent as headers instead.
+     *
+     * The mapping includes OData query parameters (prefixed with $) for pagination.
+     *
+     * @readonly
+     */
+    protected static readonly paginationParamMapping: ParameterMapping<Pick<ODataQueryParams, "top" | "skip">>;
+    /**
+     * Sends a basic API request to the specified URL with the given method and data.
+     * @param accessToken The client access token
+     * @param method The HTTP method of the request (GET, POST, DELETE, etc)
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param property Optional property name to extract from response data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns Promise resolving to a BentleyAPIResponse containing the response data or error
+     */
+    protected sendGenericAPIRequest<TResponse = unknown, TData = unknown>(accessToken: AccessToken, method: Method, url: string, data?: TData, property?: string, additionalHeaders?: Record<string, string>): Promise<BentleyAPIResponse<TResponse>>;
+    /**
+     * Build the request configuration including method, headers, and body
+     * @param accessTokenString The client access token
+     * @param method The HTTP method of the request
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns RequestConfig object with method, url, body, and headers
+     */
+    protected getRequestOptions<TData>(accessTokenString: AccessToken, method: Method, url: string, data?: TData, additionalHeaders?: Record<string, string>): RequestConfig;
     /**
-      * Build the request methods, headers, and other options
-      * @param accessTokenString The client access token string
-      */
-    protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any, additionalHeaders?: {
-        [key: string]: string;
-    }): AxiosRequestConfig;
+   * Builds a query string to be appended to a URL from query arguments
+   * @param parameterMapping - Parameter mapping configuration that maps object properties to query parameter names
+   * @param queryArg - Object containing queryable properties for filtering
+   * @returns Query string with parameters applied, ready to append to a URL
+   *
+   * @example
+   * ```typescript
+   * const queryString = this.getQueryString(
+   *   BaseClient.paginationParamMapping,
+   *   {
+   *     top: 10,
+   *     skip: 5,
+   *   }
+   * );
+   * // Returns: "$top=10&$skip=5"
+   * ```
+   */
+    protected getQueryString<T>(parameterMapping: ParameterMapping<NonNullable<T>>, queryArg?: T): string;
     /**
-      * Build a query to be appended to a URL
-      * @param queryArg Object container queryable properties
-      * @returns query string with AccessControlQueryArg applied, which should be appended to a url
-      */
-    protected getQueryString(queryArg: AccessControlQueryArg): string;
+     * Helper method to build query parameter array from mapping.
+     * Uses exhaustive parameter mapping to ensure type safety and prevent missing parameters.
+     * Automatically handles URL encoding and filters out excluded parameters.
+     *
+     * @param queryArg - Object containing queryable properties
+     * @param mapping - Parameter mapping configuration that maps object properties to query parameter names
+     * @returns Array of formatted query parameter strings ready for URL construction
+     *
+     * @example
+     * ```typescript
+     * const params = this.buildQueryParams(
+     *   { top: 10, skip: 5 },
+     *   { top: "$top", skip: "$skip" }
+     * );
+     * // Returns: ["$top=10", "$skip=5"]
+     * ```
+     */
+    private buildQueryParams;
 }
 //# sourceMappingURL=BaseClient.d.ts.map

package/lib/cjs/subClients/BaseClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE7F,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;gBAEzD,GAAG,CAAC,EAAE,MAAM;IAa/B;;;;;QAKI;cACY,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,GAAG,EACV,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAwBzC;;;QAGI;IACJ,SAAS,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,kBAAkB;IAiBlK;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAEV,kBAAkB,EAClB,MAAM,EACN,gBAAgB,EAChB,aAAa,EACd,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAe,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA8BnE;;;GAGG;AACH,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;IAE1E;;;;;;;;;;;;KAYC;gBACgB,GAAG,CAAC,EAAE,MAAM;IAa/B;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,CAI7F;IAEb;;;;;;;;;OASG;cACa,qBAAqB,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACxE,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAuDzC;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAC/B,iBAAiB,EAAE,WAAW,EAC9B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,aAAa;IAuBd;;;;;;;;;;;;;;;;;KAiBC;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,EACxB,gBAAgB,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAClD,QAAQ,CAAC,EAAE,CAAC,GACX,MAAM;IAOT;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gBAAgB;CAoBzB"}

package/lib/cjs/subClients/BaseClient.js

@@ -1,8 +1,56 @@
 "use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
-const axios_1 = require("axios");
+const typeUtils_1 = require("../types/typeUtils");
+/**
+ * Type guard to validate if an object is a valid Error structure
+ * @param error - Unknown object to validate
+ * @returns True if the object is a valid Error type
+ */
+function isValidError(error) {
+    if (typeof error !== "object" || error === null) {
+        return false;
+    }
+    const obj = error;
+    return typeof obj.code === "string" && typeof obj.message === "string";
+}
+/**
+ * Type guard to validate if response data contains an error
+ * @param data - Unknown response data to validate
+ * @returns True if the data contains a valid Error object
+ */
+function isErrorResponse(data) {
+    if (typeof data !== "object" || data === null) {
+        return false;
+    }
+    const obj = data;
+    return "error" in obj && isValidError(obj.error);
+}
+/**
+ * Base client class providing common functionality for Access Control API requests.
+ * Handles authentication, request configuration, and query string building, and error validation.
+ */
 class BaseClient {
+    /**
+   * Creates a new BaseClient instance for Access Control API operations
+   * @param url - Optional custom base URL, defaults to production iTwins API URL
+   *
+   * @example
+   * ```typescript
+   * // Use default production URL
+   * const client = new BaseClient();
+   *
+   * // Use custom URL for development/testing
+   * const client = new ITwinsAccessClient("https://api.bentley.com/accesscontrol/itwins");
+   * ```
+   */
     constructor(url) {
         this._baseUrl = "https://api.bentley.com/accesscontrol/itwins";
         if (url !== undefined) {
@@ -18,23 +66,50 @@ class BaseClient {
         }
     }
     /**
-      * Sends a basic API request
-      * @param accessTokenString The client access token string
-      * @param method The method type of the request (ex. GET, POST, DELETE, etc)
-      * @param url The url of the request
-      */
+     * Sends a basic API request to the specified URL with the given method and data.
+     * @param accessToken The client access token
+     * @param method The HTTP method of the request (GET, POST, DELETE, etc)
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param property Optional property name to extract from response data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns Promise resolving to a BentleyAPIResponse containing the response data or error
+     */
     async sendGenericAPIRequest(accessToken, method, url, data, property, additionalHeaders) {
         const requestOptions = this.getRequestOptions(accessToken, method, url, data, additionalHeaders);
         try {
-            const response = await (0, axios_1.default)(requestOptions);
+            const response = await fetch(requestOptions.url, {
+                method: requestOptions.method,
+                headers: requestOptions.headers,
+                body: requestOptions.body,
+            });
+            // Convert Headers object to plain object for compatibility
+            const headers = {};
+            response.headers.forEach((value, key) => {
+                headers[key] = value;
+            });
+            const responseData = response.status !== 204 ? await response.json() : undefined;
+            if (!response.ok) {
+                if (isErrorResponse(responseData)) {
+                    return {
+                        status: response.status,
+                        error: responseData.error,
+                        headers,
+                    };
+                }
+                throw new Error("An error occurred while processing the request");
+            }
             return {
                 status: response.status,
-                data: response.data.error || response.data === "" ? undefined : property ? response.data[property] : response.data,
-                error: response.data.error,
-                headers: response.headers,
+                data: (responseData === "" || responseData === undefined
+                    ? undefined
+                    : property && (0, typeUtils_1.hasProperty)(responseData, property)
+                        ? responseData[property]
+                        : responseData),
+                headers,
             };
         }
-        catch (err) {
+        catch (_a) {
             return {
                 status: 500,
                 error: {
@@ -46,42 +121,107 @@ class BaseClient {
         }
     }
     /**
-      * Build the request methods, headers, and other options
-      * @param accessTokenString The client access token string
-      */
+     * Build the request configuration including method, headers, and body
+     * @param accessTokenString The client access token
+     * @param method The HTTP method of the request
+     * @param url The URL of the request
+     * @param data Optional request body data
+     * @param additionalHeaders Optional additional headers to include in the request
+     * @returns RequestConfig object with method, url, body, and headers
+     */
     getRequestOptions(accessTokenString, method, url, data, additionalHeaders) {
+        if (!accessTokenString) {
+            throw new Error("Access token is required");
+        }
+        if (!url) {
+            throw new Error("URL is required");
+        }
+        const body = JSON.stringify(data);
         return {
             method,
             url,
-            data,
+            body,
             headers: {
-                "authorization": accessTokenString,
+                authorization: accessTokenString,
                 "content-type": "application/json",
-                "accept": "application/vnd.bentley.itwin-platform.v2+json",
+                accept: "application/vnd.bentley.itwin-platform.v2+json",
                 ...additionalHeaders,
             },
-            validateStatus(status) {
-                return status < 500; // Resolve only if the status code is less than 500
-            },
         };
     }
     /**
-      * Build a query to be appended to a URL
-      * @param queryArg Object container queryable properties
-      * @returns query string with AccessControlQueryArg applied, which should be appended to a url
-      */
-    getQueryString(queryArg) {
-        let queryString = "";
-        if (queryArg.top) {
-            queryString += `&$top=${queryArg.top}`;
-        }
-        if (queryArg.skip) {
-            queryString += `&$skip=${queryArg.skip}`;
+   * Builds a query string to be appended to a URL from query arguments
+   * @param parameterMapping - Parameter mapping configuration that maps object properties to query parameter names
+   * @param queryArg - Object containing queryable properties for filtering
+   * @returns Query string with parameters applied, ready to append to a URL
+   *
+   * @example
+   * ```typescript
+   * const queryString = this.getQueryString(
+   *   BaseClient.paginationParamMapping,
+   *   {
+   *     top: 10,
+   *     skip: 5,
+   *   }
+   * );
+   * // Returns: "$top=10&$skip=5"
+   * ```
+   */
+    getQueryString(parameterMapping, queryArg) {
+        if (!queryArg)
+            return "";
+        const params = this.buildQueryParams(queryArg, parameterMapping);
+        return params.join("&");
+    }
+    /**
+     * Helper method to build query parameter array from mapping.
+     * Uses exhaustive parameter mapping to ensure type safety and prevent missing parameters.
+     * Automatically handles URL encoding and filters out excluded parameters.
+     *
+     * @param queryArg - Object containing queryable properties
+     * @param mapping - Parameter mapping configuration that maps object properties to query parameter names
+     * @returns Array of formatted query parameter strings ready for URL construction
+     *
+     * @example
+     * ```typescript
+     * const params = this.buildQueryParams(
+     *   { top: 10, skip: 5 },
+     *   { top: "$top", skip: "$skip" }
+     * );
+     * // Returns: ["$top=10", "$skip=5"]
+     * ```
+     */
+    buildQueryParams(queryArg, mapping) {
+        const params = [];
+        // Type assertion constrains paramKey to actual property names and mappedValue to the specific strings from the mapping
+        // Narrows from set of all strings to only valid keys/values
+        for (const [paramKey, mappedValue] of Object.entries(mapping)) {
+            if (mappedValue === "")
+                continue;
+            const queryArgValue = queryArg[paramKey];
+            if (queryArgValue !== undefined && queryArgValue !== null) {
+                const stringValue = String(queryArgValue);
+                params.push(`${mappedValue}=${encodeURIComponent(stringValue)}`);
+            }
         }
-        // trim & from start of string
-        queryString.replace(/^&+/, "");
-        return queryString;
+        return params;
     }
 }
 exports.BaseClient = BaseClient;
+/**
+ * Maps the some properties of {@link ODataQueryParams} to their corresponding query parameter names.
+ *
+ * @remarks
+ * This mapping is used to translate internal property names to the expected parameter names
+ * when constructing requests. Properties mapped to empty strings are excluded from
+ * the query string as they should be sent as headers instead.
+ *
+ * The mapping includes OData query parameters (prefixed with $) for pagination.
+ *
+ * @readonly
+ */
+BaseClient.paginationParamMapping = {
+    top: "$top",
+    skip: "$skip",
+};
 //# sourceMappingURL=BaseClient.js.map

package/lib/cjs/subClients/BaseClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":";;;AAUA,iCAA0B;AAG1B,MAAa,UAAU;IAGrB,YAAmB,GAAY;QAFrB,aAAQ,GAAW,8CAA8C,CAAC;QAG1E,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;SACrB;aAAM;YACL,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;YAC9C,IAAI,SAAS,EAAE;gBACb,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvC,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9B;SACF;IACH,CAAC;IAED;;;;;QAKI;IACM,KAAK,CAAC,qBAAqB,CACnC,WAAwB,EACxB,MAAc,EACd,GAAW,EACX,IAAU,EACV,QAAiB,EACjB,iBAA6C;QAE7C,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;QACjG,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,eAAK,EAAC,cAAc,CAAC,CAAC;YAE7C,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBAClH,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;gBAC1B,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE;oBACL,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EACL,6DAA6D;iBAChE;gBACD,OAAO,EAAE,EAAE;aACZ,CAAC;SACH;IACH,CAAC;IAED;;;QAGI;IACM,iBAAiB,CAAC,iBAAyB,EAAE,MAAc,EAAE,GAAW,EAAE,IAAU,EAAE,iBAA6C;QAC3I,OAAO;YACL,MAAM;YACN,GAAG;YACH,IAAI;YACJ,OAAO,EAAE;gBACP,eAAe,EAAE,iBAAiB;gBAClC,cAAc,EAAE,kBAAkB;gBAClC,QAAQ,EAAE,gDAAgD;gBAC1D,GAAG,iBAAiB;aACrB;YACD,cAAc,CAAC,MAAM;gBACnB,OAAO,MAAM,GAAG,GAAG,CAAC,CAAC,mDAAmD;YAC1E,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;QAII;IACM,cAAc,CAAC,QAA+B;QACtD,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,IAAI,QAAQ,CAAC,GAAG,EAAE;YAChB,WAAW,IAAI,SAAS,QAAQ,CAAC,GAAG,EAAE,CAAC;SACxC;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,WAAW,IAAI,UAAU,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1C;QAED,8BAA8B;QAC9B,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE/B,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AA/FD,gCA+FC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { Method } from \"axios\";\r\nimport type { AxiosRequestConfig } from \"axios\";\r\nimport axios from \"axios\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg } from \"../accessControlTypes\";\r\n\r\nexport class BaseClient {\r\n  protected _baseUrl: string = \"https://api.bentley.com/accesscontrol/itwins\";\r\n\r\n  public constructor(url?: string) {\r\n    if (url !== undefined) {\r\n      this._baseUrl = url;\r\n    } else {\r\n      const urlPrefix = process.env.IMJS_URL_PREFIX;\r\n      if (urlPrefix) {\r\n        const baseUrl = new URL(this._baseUrl);\r\n        baseUrl.hostname = urlPrefix + baseUrl.hostname;\r\n        this._baseUrl = baseUrl.href;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Sends a basic API request\r\n    * @param accessTokenString The client access token string\r\n    * @param method The method type of the request (ex. GET, POST, DELETE, etc)\r\n    * @param url The url of the request\r\n    */\r\n  protected async sendGenericAPIRequest(\r\n    accessToken: AccessToken,\r\n    method: Method,\r\n    url: string,\r\n    data?: any,\r\n    property?: string,\r\n    additionalHeaders?: { [key: string]: string }\r\n  ): Promise<AccessControlAPIResponse<any>> { // TODO: Change any response\r\n    const requestOptions = this.getRequestOptions(accessToken, method, url, data, additionalHeaders);\r\n    try {\r\n      const response = await axios(requestOptions);\r\n\r\n      return {\r\n        status: response.status,\r\n        data: response.data.error || response.data === \"\" ? undefined : property ? response.data[property] : response.data,\r\n        error: response.data.error,\r\n        headers: response.headers,\r\n      };\r\n    } catch (err) {\r\n      return {\r\n        status: 500,\r\n        error: {\r\n          code: \"InternalServerError\",\r\n          message:\r\n            \"An internal exception happened while calling iTwins Service\",\r\n        },\r\n        headers: {},\r\n      };\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Build the request methods, headers, and other options\r\n    * @param accessTokenString The client access token string\r\n    */\r\n  protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any, additionalHeaders?: { [key: string]: string }): AxiosRequestConfig {\r\n    return {\r\n      method,\r\n      url,\r\n      data,\r\n      headers: {\r\n        \"authorization\": accessTokenString,\r\n        \"content-type\": \"application/json\",\r\n        \"accept\": \"application/vnd.bentley.itwin-platform.v2+json\",\r\n        ...additionalHeaders,\r\n      },\r\n      validateStatus(status) {\r\n        return status < 500; // Resolve only if the status code is less than 500\r\n      },\r\n    };\r\n  }\r\n\r\n  /**\r\n    * Build a query to be appended to a URL\r\n    * @param queryArg Object container queryable properties\r\n    * @returns query string with AccessControlQueryArg applied, which should be appended to a url\r\n    */\r\n  protected getQueryString(queryArg: AccessControlQueryArg): string {\r\n    let queryString = \"\";\r\n\r\n    if (queryArg.top) {\r\n      queryString += `&$top=${queryArg.top}`;\r\n    }\r\n\r\n    if (queryArg.skip) {\r\n      queryString += `&$skip=${queryArg.skip}`;\r\n    }\r\n\r\n    // trim & from start of string\r\n    queryString.replace(/^&+/, \"\");\r\n\r\n    return queryString;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAUH,kDAAmE;AAEnE;;;;GAIG;AACH,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,KAAgC,CAAC;IAC7C,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAa;IACpC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,IAA+B,CAAC;IAC5C,OAAO,OAAO,IAAI,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,MAAa,UAAU;IAGnB;;;;;;;;;;;;KAYC;IACH,YAAmB,GAAY;QAfrB,aAAQ,GAAW,8CAA8C,CAAC;QAgB1E,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;YAC9C,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvC,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAoBD;;;;;;;;;OASG;IACO,KAAK,CAAC,qBAAqB,CACnC,WAAwB,EACxB,MAAc,EACd,GAAW,EACX,IAAY,EACZ,QAAiB,EACjB,iBAA0C;QAE1C,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAC3C,WAAW,EACX,MAAM,EACN,GAAG,EACH,IAAI,EACJ,iBAAiB,CAClB,CAAC;QACF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE;gBAC/C,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,OAAO,EAAE,cAAc,CAAC,OAAO;gBAC/B,IAAI,EAAE,cAAc,CAAC,IAAI;aAC1B,CAAC,CAAC;YACH,2DAA2D;YAC3D,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,MAAM,YAAY,GAChB,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,IAAI,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;oBAClC,OAAO;wBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,KAAK,EAAE,YAAY,CAAC,KAAK;wBACzB,OAAO;qBACR,CAAC;gBACJ,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACpE,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EACF,CAAC,YAAY,KAAK,EAAE,IAAI,YAAY,KAAK,SAAS;oBAChD,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,QAAQ,IAAI,IAAA,uBAAW,EAAC,YAAY,EAAE,QAAQ,CAAC;wBACjD,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;wBACxB,CAAC,CAAC,YAAY,CAAc;gBAChC,OAAO;aACR,CAAC;QACJ,CAAC;QAAC,WAAM,CAAC;YACP,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE;oBACL,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EACL,6DAA6D;iBAChE;gBACD,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACO,iBAAiB,CACzB,iBAA8B,EAC9B,MAAc,EACd,GAAW,EACX,IAAY,EACZ,iBAA0C;QAE1C,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,IAAI,GAAuB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtD,OAAO;YACL,MAAM;YACN,GAAG;YACH,IAAI;YACJ,OAAO,EAAE;gBACP,aAAa,EAAE,iBAAiB;gBAChC,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,gDAAgD;gBACxD,GAAG,iBAAiB;aACrB;SACF,CAAC;IACJ,CAAC;IAEC;;;;;;;;;;;;;;;;;KAiBC;IACO,cAAc,CACtB,gBAAkD,EAClD,QAAY;QAEZ,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACK,gBAAgB,CACtB,QAAW,EACX,OAA4B;QAE5B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,uHAAuH;QACvH,4DAA4D;QAC5D,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAGzD,EAAE,CAAC;YACJ,IAAI,WAAW,KAAK,EAAE;gBAAE,SAAS;YACjC,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC1D,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;;AA9NH,gCA+NC;AAlMC;;;;;;;;;;;GAWG;AACuB,iCAAsB,GAC9C;IACE,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,OAAO;CACL,AAJoC,CAInC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type {\r\n  ApimError,\r\n  BentleyAPIResponse,\r\n  Method,\r\n  ODataQueryParams,\r\n  RequestConfig,\r\n} from \"../types/CommonApiTypes\";\r\nimport { hasProperty, ParameterMapping } from \"../types/typeUtils\";\r\n\r\n/**\r\n * Type guard to validate if an object is a valid Error structure\r\n * @param error - Unknown object to validate\r\n * @returns True if the object is a valid Error type\r\n */\r\nfunction isValidError(error: unknown): error is ApimError {\r\n  if (typeof error !== \"object\" || error === null) {\r\n    return false;\r\n  }\r\n\r\n  const obj = error as Record<string, unknown>;\r\n  return typeof obj.code === \"string\" && typeof obj.message === \"string\";\r\n}\r\n\r\n/**\r\n * Type guard to validate if response data contains an error\r\n * @param data - Unknown response data to validate\r\n * @returns True if the data contains a valid Error object\r\n */\r\nfunction isErrorResponse(data: unknown): data is { error: ApimError } {\r\n  if (typeof data !== \"object\" || data === null) {\r\n    return false;\r\n  }\r\n\r\n  const obj = data as Record<string, unknown>;\r\n  return \"error\" in obj && isValidError(obj.error);\r\n}\r\n\r\n/**\r\n * Base client class providing common functionality for Access Control API requests.\r\n * Handles authentication, request configuration, and query string building, and error validation.\r\n */\r\nexport class BaseClient {\r\n  protected _baseUrl: string = \"https://api.bentley.com/accesscontrol/itwins\";\r\n\r\n    /**\r\n   * Creates a new BaseClient instance for Access Control API operations\r\n   * @param url - Optional custom base URL, defaults to production iTwins API URL\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * // Use default production URL\r\n   * const client = new BaseClient();\r\n   *\r\n   * // Use custom URL for development/testing\r\n   * const client = new ITwinsAccessClient(\"https://api.bentley.com/accesscontrol/itwins\");\r\n   * ```\r\n   */\r\n  public constructor(url?: string) {\r\n    if (url !== undefined) {\r\n      this._baseUrl = url;\r\n    } else {\r\n      const urlPrefix = process.env.IMJS_URL_PREFIX;\r\n      if (urlPrefix) {\r\n        const baseUrl = new URL(this._baseUrl);\r\n        baseUrl.hostname = urlPrefix + baseUrl.hostname;\r\n        this._baseUrl = baseUrl.href;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Maps the some properties of {@link ODataQueryParams} to their corresponding query parameter names.\r\n   *\r\n   * @remarks\r\n   * This mapping is used to translate internal property names to the expected parameter names\r\n   * when constructing requests. Properties mapped to empty strings are excluded from\r\n   * the query string as they should be sent as headers instead.\r\n   *\r\n   * The mapping includes OData query parameters (prefixed with $) for pagination.\r\n   *\r\n   * @readonly\r\n   */\r\n  protected static readonly paginationParamMapping: ParameterMapping<Pick<ODataQueryParams, \"top\" | \"skip\">> =\r\n    {\r\n      top: \"$top\",\r\n      skip: \"$skip\",\r\n    } as const;\r\n\r\n  /**\r\n   * Sends a basic API request to the specified URL with the given method and data.\r\n   * @param accessToken The client access token\r\n   * @param method The HTTP method of the request (GET, POST, DELETE, etc)\r\n   * @param url The URL of the request\r\n   * @param data Optional request body data\r\n   * @param property Optional property name to extract from response data\r\n   * @param additionalHeaders Optional additional headers to include in the request\r\n   * @returns Promise resolving to a BentleyAPIResponse containing the response data or error\r\n   */\r\n  protected async sendGenericAPIRequest<TResponse = unknown, TData = unknown>(\r\n    accessToken: AccessToken,\r\n    method: Method,\r\n    url: string,\r\n    data?: TData,\r\n    property?: string,\r\n    additionalHeaders?: Record<string, string>\r\n  ): Promise<BentleyAPIResponse<TResponse>> {\r\n    const requestOptions = this.getRequestOptions(\r\n      accessToken,\r\n      method,\r\n      url,\r\n      data,\r\n      additionalHeaders\r\n    );\r\n    try {\r\n      const response = await fetch(requestOptions.url, {\r\n        method: requestOptions.method,\r\n        headers: requestOptions.headers,\r\n        body: requestOptions.body,\r\n      });\r\n      // Convert Headers object to plain object for compatibility\r\n      const headers: Record<string, string> = {};\r\n      response.headers.forEach((value, key) => {\r\n        headers[key] = value;\r\n      });\r\n      const responseData =\r\n        response.status !== 204 ? await response.json() : undefined;\r\n\r\n      if (!response.ok) {\r\n        if (isErrorResponse(responseData)) {\r\n          return {\r\n            status: response.status,\r\n            error: responseData.error,\r\n            headers,\r\n          };\r\n        }\r\n        throw new Error(\"An error occurred while processing the request\");\r\n      }\r\n      return {\r\n        status: response.status,\r\n        data:\r\n          (responseData === \"\" || responseData === undefined\r\n            ? undefined\r\n            : property && hasProperty(responseData, property)\r\n            ? responseData[property]\r\n            : responseData) as TResponse,\r\n        headers,\r\n      };\r\n    } catch {\r\n      return {\r\n        status: 500,\r\n        error: {\r\n          code: \"InternalServerError\",\r\n          message:\r\n            \"An internal exception happened while calling iTwins Service\",\r\n        },\r\n        headers: {},\r\n      };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Build the request configuration including method, headers, and body\r\n   * @param accessTokenString The client access token\r\n   * @param method The HTTP method of the request\r\n   * @param url The URL of the request\r\n   * @param data Optional request body data\r\n   * @param additionalHeaders Optional additional headers to include in the request\r\n   * @returns RequestConfig object with method, url, body, and headers\r\n   */\r\n  protected getRequestOptions<TData>(\r\n    accessTokenString: AccessToken,\r\n    method: Method,\r\n    url: string,\r\n    data?: TData,\r\n    additionalHeaders?: Record<string, string>\r\n  ): RequestConfig {\r\n    if (!accessTokenString) {\r\n      throw new Error(\"Access token is required\");\r\n    }\r\n\r\n    if (!url) {\r\n      throw new Error(\"URL is required\");\r\n    }\r\n    const body: string | undefined = JSON.stringify(data);\r\n\r\n    return {\r\n      method,\r\n      url,\r\n      body,\r\n      headers: {\r\n        authorization: accessTokenString,\r\n        \"content-type\": \"application/json\",\r\n        accept: \"application/vnd.bentley.itwin-platform.v2+json\",\r\n        ...additionalHeaders,\r\n      },\r\n    };\r\n  }\r\n\r\n    /**\r\n   * Builds a query string to be appended to a URL from query arguments\r\n   * @param parameterMapping - Parameter mapping configuration that maps object properties to query parameter names\r\n   * @param queryArg - Object containing queryable properties for filtering\r\n   * @returns Query string with parameters applied, ready to append to a URL\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const queryString = this.getQueryString(\r\n   *   BaseClient.paginationParamMapping,\r\n   *   {\r\n   *     top: 10,\r\n   *     skip: 5,\r\n   *   }\r\n   * );\r\n   * // Returns: \"$top=10&$skip=5\"\r\n   * ```\r\n   */\r\n  protected getQueryString<T>(\r\n    parameterMapping: ParameterMapping<NonNullable<T>>,\r\n    queryArg?: T\r\n  ): string {\r\n    if (!queryArg) return \"\";\r\n\r\n    const params = this.buildQueryParams(queryArg, parameterMapping);\r\n    return params.join(\"&\");\r\n  }\r\n\r\n  /**\r\n   * Helper method to build query parameter array from mapping.\r\n   * Uses exhaustive parameter mapping to ensure type safety and prevent missing parameters.\r\n   * Automatically handles URL encoding and filters out excluded parameters.\r\n   *\r\n   * @param queryArg - Object containing queryable properties\r\n   * @param mapping - Parameter mapping configuration that maps object properties to query parameter names\r\n   * @returns Array of formatted query parameter strings ready for URL construction\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const params = this.buildQueryParams(\r\n   *   { top: 10, skip: 5 },\r\n   *   { top: \"$top\", skip: \"$skip\" }\r\n   * );\r\n   * // Returns: [\"$top=10\", \"$skip=5\"]\r\n   * ```\r\n   */\r\n  private buildQueryParams<T>(\r\n    queryArg: T,\r\n    mapping: ParameterMapping<T>\r\n  ): string[] {\r\n    const params: string[] = [];\r\n    // Type assertion constrains paramKey to actual property names and mappedValue to the specific strings from the mapping\r\n    // Narrows from set of all strings to only valid keys/values\r\n    for (const [paramKey, mappedValue] of Object.entries(mapping) as [\r\n      keyof T,\r\n      ParameterMapping<T>[keyof T]\r\n    ][]) {\r\n      if (mappedValue === \"\") continue;\r\n      const queryArgValue = queryArg[paramKey];\r\n      if (queryArgValue !== undefined && queryArgValue !== null) {\r\n        const stringValue = String(queryArgValue);\r\n        params.push(`${mappedValue}=${encodeURIComponent(stringValue)}`);\r\n      }\r\n    }\r\n    return params;\r\n  }\r\n}\r\n"]}

package/lib/cjs/subClients/GroupMemberInvitationsClient.d.ts

@@ -0,0 +1,33 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { MultipleGroupMemberInvitationResponse } from "../access-control-client";
+import type { IGroupMemberInvitationClient } from "../accessControlClientInterfaces/GroupMemberInvitationClient";
+import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
+import { BaseClient } from "./BaseClient";
+/** Client API to perform iTwin group members operations.
+ * @beta
+ */
+export declare class GroupMemberInvitationClient extends BaseClient implements IGroupMemberInvitationClient {
+    /** Create a new GroupMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
+    constructor(url?: string);
+    /** Retrieves a list of iTwin group members and their roles assignments.
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @beta
+     * @returns Array of members
+     */
+    queryITwinGroupMemberInvitations(accessToken: AccessToken, iTwinId: string, groupId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleGroupMemberInvitationResponse>>;
+    /** Deletes a member invitations.
+   * @param accessToken The client access token string
+   * @param iTwinId The id of the iTwin
+   * @param invitationId The id of the invitation id
+   * @beta
+   * @returns Array of member invitations
+   */
+    deleteITwinGroupMemberInvitation(accessToken: AccessToken, iTwinId: string, groupId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
+}
+//# sourceMappingURL=GroupMemberInvitationsClient.d.ts.map

package/lib/cjs/subClients/GroupMemberInvitationsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupMemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupMemberInvitationsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,0BAA0B,CAAC;AACtF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8DAA8D,CAAC;AACjH,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,2BACX,SAAQ,UACR,YAAW,4BAA4B;IACvC;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;OAKG;IACU,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,qCAAqC,CAAC,CAAC;IAenE;;;;;;KAMC;IACU,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAI1C"}

package/lib/cjs/subClients/GroupMemberInvitationsClient.js

@@ -0,0 +1,48 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupMemberInvitationClient = void 0;
+const BaseClient_1 = require("./BaseClient");
+/** Client API to perform iTwin group members operations.
+ * @beta
+ */
+class GroupMemberInvitationClient extends BaseClient_1.BaseClient {
+    /** Create a new GroupMembersClient instance
+     * @param url Optional base URL for the access control service. If not provided, defaults to base url.
+     */
+    constructor(url) {
+        super(url);
+    }
+    /** Retrieves a list of iTwin group members and their roles assignments.
+     * @param accessToken The client access token string
+     * @param iTwinId The id of the iTwin
+     * @beta
+     * @returns Array of members
+     */
+    async queryITwinGroupMemberInvitations(accessToken, iTwinId, groupId, arg) {
+        let url = `${this._baseUrl}/${iTwinId}/groups/${groupId}/invitations`;
+        if (arg) {
+            url += `?${this.getQueryString(GroupMemberInvitationClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}`;
+        }
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
+    }
+    /** Deletes a member invitations.
+   * @param accessToken The client access token string
+   * @param iTwinId The id of the iTwin
+   * @param invitationId The id of the invitation id
+   * @beta
+   * @returns Array of member invitations
+   */
+    async deleteITwinGroupMemberInvitation(accessToken, iTwinId, groupId, invitationId) {
+        const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}/invitations/${invitationId}`;
+        return this.sendGenericAPIRequest(accessToken, "DELETE", url);
+    }
+}
+exports.GroupMemberInvitationClient = GroupMemberInvitationClient;
+//# sourceMappingURL=GroupMemberInvitationsClient.js.map

package/lib/cjs/subClients/GroupMemberInvitationsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupMemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupMemberInvitationsClient.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAMH,6CAA0C;AAE1C;;GAEG;AACH,MAAa,2BACX,SAAQ,uBAAU;IAElB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,GAA4C;QAE5C,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,cAAc,CAAC;QAEtE,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,2BAA2B,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACzH,CAAC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAEC;;;;;;KAMC;IACI,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,YAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,gBAAgB,YAAY,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF;AApDD,kEAoDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { MultipleGroupMemberInvitationResponse } from \"../access-control-client\";\nimport type { IGroupMemberInvitationClient } from \"../accessControlClientInterfaces/GroupMemberInvitationClient\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin group members operations.\n * @beta\n */\nexport class GroupMemberInvitationClient\n  extends BaseClient\n  implements IGroupMemberInvitationClient {\n  /** Create a new GroupMembersClient instance\n   * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n   */\n  public constructor(url?: string) {\n    super(url);\n  }\n\n  /** Retrieves a list of iTwin group members and their roles assignments.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @beta\n   * @returns Array of members\n   */\n  public async queryITwinGroupMemberInvitations(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n    arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n  ): Promise<BentleyAPIResponse<MultipleGroupMemberInvitationResponse>> {\n    let url = `${this._baseUrl}/${iTwinId}/groups/${groupId}/invitations`;\n\n    if (arg) {\n      url += `?${this.getQueryString(GroupMemberInvitationClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}`;\n    }\n\n    return this.sendGenericAPIRequest(\n      accessToken,\n      \"GET\",\n      url,\n      undefined,\n    );\n  }\n\n    /** Deletes a member invitations.\n   * @param accessToken The client access token string\n   * @param iTwinId The id of the iTwin\n   * @param invitationId The id of the invitation id\n   * @beta\n   * @returns Array of member invitations\n   */\n  public async deleteITwinGroupMemberInvitation(\n    accessToken: AccessToken,\n    iTwinId: string,\n    groupId: string,\n    invitationId: string\n  ): Promise<BentleyAPIResponse<undefined>> {\n    const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}/invitations/${invitationId}`;\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n  }\n}\n"]}