@salesforce/b2c-tooling-sdk 0.3.0 → 0.4.0

package/dist/esm/operations/ods/wait-for-sandbox.js

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+import { getLogger } from '../../logging/logger.js';
+export class SandboxPollingTimeoutError extends Error {
+    sandboxId;
+    targetState;
+    timeoutSeconds;
+    lastState;
+    constructor(sandboxId, targetState, timeoutSeconds, lastState) {
+        super(`Timeout waiting for sandbox ${sandboxId} to reach state ${targetState} after ${timeoutSeconds} seconds${lastState ? ` (lastState=${lastState})` : ''}`);
+        this.sandboxId = sandboxId;
+        this.targetState = targetState;
+        this.timeoutSeconds = timeoutSeconds;
+        this.lastState = lastState;
+        this.name = 'SandboxPollingTimeoutError';
+    }
+}
+export class SandboxPollingError extends Error {
+    sandboxId;
+    message;
+    constructor(sandboxId, message) {
+        super(`Failed to fetch sandbox status for ${sandboxId}: ${message}`);
+        this.sandboxId = sandboxId;
+        this.message = message;
+        this.name = 'SandboxPollingError';
+    }
+}
+export class SandboxTerminalStateError extends Error {
+    sandboxId;
+    targetState;
+    state;
+    constructor(sandboxId, targetState, state) {
+        super(`Sandbox ${sandboxId} reached terminal state ${state} while waiting for ${targetState}`);
+        this.sandboxId = sandboxId;
+        this.targetState = targetState;
+        this.state = state;
+        this.name = 'SandboxTerminalStateError';
+    }
+}
+async function defaultSleep(ms) {
+    await new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+/**
+ * Waits for a sandbox to reach a target state by polling its status.
+ *
+ * This function polls the ODS API at regular intervals until the sandbox reaches the desired state,
+ * times out, or enters a terminal error state (failed/deleted).
+ *
+ * @param client - ODS client for API calls
+ * @param options - Polling configuration options
+ * @param options.sandboxId - ID of the sandbox to monitor
+ * @param options.targetState - Desired sandbox state (e.g., 'started', 'stopped', 'deleted')
+ * @param options.pollIntervalSeconds - Seconds between status checks
+ * @param options.timeoutSeconds - Maximum seconds to wait (0 = no timeout)
+ * @param options.onPoll - Optional callback invoked on each poll with current state
+ * @param options.sleep - Optional custom sleep function (primarily for testing)
+ *
+ * @throws {SandboxPollingTimeoutError} If the timeout is exceeded before reaching target state
+ * @throws {SandboxPollingError} If the API request fails
+ * @throws {SandboxTerminalStateError} If the sandbox enters a terminal error state
+ *
+ * @example
+ * ```typescript
+ * await waitForSandbox(odsClient, {
+ *   sandboxId: 'abc-123',
+ *   targetState: 'started',
+ *   pollIntervalSeconds: 5,
+ *   timeoutSeconds: 300,
+ *   onPoll: (info) => console.log(`State: ${info.state} (${info.elapsedSeconds}s)`),
+ * });
+ * ```
+ */
+export async function waitForSandbox(client, options) {
+    const logger = getLogger();
+    const { sandboxId, targetState, pollIntervalSeconds, timeoutSeconds } = options;
+    const sleepFn = options.sleep ?? defaultSleep;
+    const startTime = Date.now();
+    const pollIntervalMs = pollIntervalSeconds * 1000;
+    const timeoutMs = timeoutSeconds * 1000;
+    await sleepFn(pollIntervalMs);
+    let lastState;
+    while (true) {
+        const elapsedSeconds = Math.round((Date.now() - startTime) / 1000);
+        if (timeoutSeconds > 0 && Date.now() - startTime > timeoutMs) {
+            throw new SandboxPollingTimeoutError(sandboxId, targetState, timeoutSeconds, lastState);
+        }
+        const result = await client.GET('/sandboxes/{sandboxId}', {
+            params: {
+                path: { sandboxId },
+            },
+        });
+        if (!result.data?.data) {
+            throw new SandboxPollingError(sandboxId, result.response?.statusText || 'Unknown error');
+        }
+        const sandbox = result.data.data;
+        const currentState = sandbox.state || 'unknown';
+        lastState = currentState;
+        logger.trace({ sandboxId, elapsedSeconds, state: currentState }, '[ODS] Sandbox poll');
+        options.onPoll?.({ sandboxId, elapsedSeconds, state: currentState });
+        if (currentState === targetState) {
+            return;
+        }
+        if (currentState === 'failed' || currentState === 'deleted') {
+            throw new SandboxTerminalStateError(sandboxId, targetState, currentState);
+        }
+        await sleepFn(pollIntervalMs);
+    }
+}
+//# sourceMappingURL=wait-for-sandbox.js.map

package/dist/esm/operations/ods/wait-for-sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-sandbox.js","sourceRoot":"","sources":["../../../../src/operations/ods/wait-for-sandbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAIlD,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IAEjC;IACA;IACA;IACA;IAJlB,YACkB,SAAiB,EACjB,WAAyB,EACzB,cAAsB,EACtB,SAAwB;QAExC,KAAK,CACH,+BAA+B,SAAS,mBAAmB,WAAW,UAAU,cAAc,WAC5F,SAAS,CAAC,CAAC,CAAC,eAAe,SAAS,GAAG,CAAC,CAAC,CAAC,EAC5C,EAAE,CACH,CAAC;QATc,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAc;QACzB,mBAAc,GAAd,cAAc,CAAQ;QACtB,cAAS,GAAT,SAAS,CAAe;QAOxC,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAC;IAC3C,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAE1B;IACA;IAFlB,YACkB,SAAiB,EACjB,OAAe;QAE/B,KAAK,CAAC,sCAAsC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;QAHrD,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAQ;QAG/B,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAEhC;IACA;IACA;IAHlB,YACkB,SAAiB,EACjB,WAAyB,EACzB,KAAmB;QAEnC,KAAK,CAAC,WAAW,SAAS,2BAA2B,KAAK,sBAAsB,WAAW,EAAE,CAAC,CAAC;QAJ/E,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAc;QACzB,UAAK,GAAL,KAAK,CAAc;QAGnC,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAiBD,KAAK,UAAU,YAAY,CAAC,EAAU;IACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAiB,EAAE,OAA8B;IACpF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,SAAS,EAAE,WAAW,EAAE,mBAAmB,EAAE,cAAc,EAAC,GAAG,OAAO,CAAC;IAE9E,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC;IAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,cAAc,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAClD,MAAM,SAAS,GAAG,cAAc,GAAG,IAAI,CAAC;IAExC,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAE9B,IAAI,SAAmC,CAAC;IAExC,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QAEnE,IAAI,cAAc,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,0BAA0B,CAAC,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YACxD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAC,SAAS,EAAC;aAClB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,UAAU,IAAI,eAAe,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,MAAM,YAAY,GAAI,OAAO,CAAC,KAAsB,IAAI,SAAS,CAAC;QAClE,SAAS,GAAG,YAAY,CAAC;QAEzB,MAAM,CAAC,KAAK,CAAC,EAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAC,EAAE,oBAAoB,CAAC,CAAC;QACrF,OAAO,CAAC,MAAM,EAAE,CAAC,EAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC,CAAC;QAEnE,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC5D,MAAM,IAAI,yBAAyB,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,CAAC;AACH,CAAC"}

package/dist/esm/operations/orgs/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Account Manager organization management operations.
+ *
+ * This module provides high-level functions for managing organizations in Account Manager,
+ * including retrieving organization details.
+ *
+ * ## Core Organization Functions
+ *
+ * - {@link getOrg} - Get organization details by ID
+ * - {@link getOrgByName} - Get organization details by name
+ * - {@link listOrgs} - List organizations with pagination
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import {
+ *   getOrg,
+ *   getOrgByName,
+ *   listOrgs,
+ * } from '@salesforce/b2c-tooling-sdk/operations/orgs';
+ * import {createAccountManagerOrgsClient} from '@salesforce/b2c-tooling-sdk/clients';
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
+ *
+ * const auth = new OAuthStrategy({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ * });
+ *
+ * const client = createAccountManagerOrgsClient({}, auth);
+ *
+ * // Get an organization by ID
+ * const org = await getOrg(client, 'org-id');
+ *
+ * // Get an organization by name
+ * const org = await getOrgByName(client, 'My Organization');
+ *
+ * // List organizations
+ * const orgs = await listOrgs(client, {size: 25, page: 0});
+ * ```
+ *
+ * ## Authentication
+ *
+ * Organization operations require OAuth authentication with appropriate Account Manager permissions.
+ *
+ * @module operations/orgs
+ */
+import type { AccountManagerOrgsClient, AccountManagerOrganization, OrganizationCollection, ListOrgsOptions } from '../../clients/am-api.js';
+export type { AccountManagerOrganization, OrganizationCollection, ListOrgsOptions } from '../../clients/am-api.js';
+/**
+ * Gets an organization by ID.
+ *
+ * @param client - Account Manager Organizations client
+ * @param orgId - Organization ID
+ * @returns Organization details
+ * @throws Error if organization is not found
+ */
+export declare function getOrg(client: AccountManagerOrgsClient, orgId: string): Promise<AccountManagerOrganization>;
+/**
+ * Gets an organization by name (searches for exact or partial match).
+ *
+ * @param client - Account Manager Organizations client
+ * @param name - Organization name
+ * @returns Organization details
+ * @throws Error if organization is not found or ambiguous
+ */
+export declare function getOrgByName(client: AccountManagerOrgsClient, name: string): Promise<AccountManagerOrganization>;
+/**
+ * Lists organizations with pagination.
+ *
+ * @param client - Account Manager Organizations client
+ * @param options - List options (size, page, all)
+ * @returns Organization collection
+ */
+export declare function listOrgs(client: AccountManagerOrgsClient, options?: ListOrgsOptions): Promise<OrganizationCollection>;

package/dist/esm/operations/orgs/index.js

@@ -0,0 +1,33 @@
+/**
+ * Gets an organization by ID.
+ *
+ * @param client - Account Manager Organizations client
+ * @param orgId - Organization ID
+ * @returns Organization details
+ * @throws Error if organization is not found
+ */
+export async function getOrg(client, orgId) {
+    return client.getOrg(orgId);
+}
+/**
+ * Gets an organization by name (searches for exact or partial match).
+ *
+ * @param client - Account Manager Organizations client
+ * @param name - Organization name
+ * @returns Organization details
+ * @throws Error if organization is not found or ambiguous
+ */
+export async function getOrgByName(client, name) {
+    return client.getOrgByName(name);
+}
+/**
+ * Lists organizations with pagination.
+ *
+ * @param client - Account Manager Organizations client
+ * @param options - List options (size, page, all)
+ * @returns Organization collection
+ */
+export async function listOrgs(client, options) {
+    return client.listOrgs(options);
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/operations/orgs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/orgs/index.ts"],"names":[],"mappings":"AA6DA;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,MAAgC,EAAE,KAAa;IAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAgC,EAChC,IAAY;IAEZ,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAgC,EAChC,OAAyB;IAEzB,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC"}

package/dist/esm/operations/roles/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Account Manager role management operations.
+ *
+ * This module provides high-level functions for retrieving role information
+ * in Account Manager, including listing roles and getting role details.
+ *
+ * ## Core Role Functions
+ *
+ * - {@link getRole} - Get role details by ID
+ * - {@link listRoles} - List roles with pagination
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import {getRole, listRoles} from '@salesforce/b2c-tooling-sdk/operations/roles';
+ * import {createAccountManagerRolesClient} from '@salesforce/b2c-tooling-sdk/clients';
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
+ *
+ * const auth = new OAuthStrategy({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ * });
+ *
+ * const client = createAccountManagerRolesClient({}, auth);
+ *
+ * // Get a role by ID
+ * const role = await getRole(client, 'bm-admin');
+ *
+ * // List roles
+ * const roles = await listRoles(client, {size: 25, page: 0});
+ *
+ * // List roles filtered by target type
+ * const userRoles = await listRoles(client, {size: 25, page: 0, roleTargetType: 'User'});
+ * ```
+ *
+ * ## Authentication
+ *
+ * Role operations require OAuth authentication with appropriate Account Manager permissions.
+ *
+ * @module operations/roles
+ */
+export { getRole, listRoles } from '../../clients/am-api.js';
+export type { AccountManagerRole, RoleCollection, ListRolesOptions } from '../../clients/am-api.js';

package/dist/esm/operations/roles/index.js

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+/**
+ * Account Manager role management operations.
+ *
+ * This module provides high-level functions for retrieving role information
+ * in Account Manager, including listing roles and getting role details.
+ *
+ * ## Core Role Functions
+ *
+ * - {@link getRole} - Get role details by ID
+ * - {@link listRoles} - List roles with pagination
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import {getRole, listRoles} from '@salesforce/b2c-tooling-sdk/operations/roles';
+ * import {createAccountManagerRolesClient} from '@salesforce/b2c-tooling-sdk/clients';
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
+ *
+ * const auth = new OAuthStrategy({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ * });
+ *
+ * const client = createAccountManagerRolesClient({}, auth);
+ *
+ * // Get a role by ID
+ * const role = await getRole(client, 'bm-admin');
+ *
+ * // List roles
+ * const roles = await listRoles(client, {size: 25, page: 0});
+ *
+ * // List roles filtered by target type
+ * const userRoles = await listRoles(client, {size: 25, page: 0, roleTargetType: 'User'});
+ * ```
+ *
+ * ## Authentication
+ *
+ * Role operations require OAuth authentication with appropriate Account Manager permissions.
+ *
+ * @module operations/roles
+ */
+export { getRole, listRoles } from '../../clients/am-api.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/operations/roles/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/roles/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,yBAAyB,CAAC"}

package/dist/esm/operations/users/index.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Account Manager user management operations.
+ *
+ * This module provides high-level functions for managing users in Account Manager,
+ * including CRUD operations, role management, and user lifecycle operations.
+ *
+ * ## Core User Functions
+ *
+ * - {@link getUser} - Get user details by ID
+ * - {@link getUserByLogin} - Get user details by login (email)
+ * - {@link listUsers} - List users with pagination
+ * - {@link createUser} - Create a new user
+ * - {@link updateUser} - Update an existing user
+ * - {@link deleteUser} - Disable a user (soft delete)
+ * - {@link purgeUser} - Purge a disabled user (hard delete)
+ * - {@link resetUser} - Reset a user to INITIAL state
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import {
+ *   getUserByLogin,
+ *   listUsers,
+ *   createUser,
+ *   grantRole,
+ * } from '@salesforce/b2c-tooling-sdk/operations/users';
+ * import { createAccountManagerUsersClient } from '@salesforce/b2c-tooling-sdk/clients';
+ * import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
+ *
+ * const auth = new OAuthStrategy({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ * });
+ *
+ * const client = createAccountManagerUsersClient({}, auth);
+ *
+ * // Get a user by login
+ * const user = await getUserByLogin(client, 'user@example.com');
+ *
+ * // List users
+ * const users = await listUsers(client, { size: 25, page: 0 });
+ *
+ * // Create a new user
+ * const newUser = await createUser(client, {
+ *   mail: 'newuser@example.com',
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   organizations: ['org-id'],
+ *   primaryOrganization: 'org-id',
+ * });
+ * ```
+ *
+ * ## Authentication
+ *
+ * User operations require OAuth authentication with appropriate Account Manager permissions.
+ *
+ * @module operations/users
+ */
+import type { AccountManagerUsersClient, AccountManagerUser, UserCreate, UserUpdate } from '../../clients/am-api.js';
+import { getUser, listUsers, deleteUser, purgeUser, resetUser } from '../../clients/am-api.js';
+/**
+ * Options for creating a user.
+ */
+export interface CreateUserOptions {
+    /** User details */
+    user: UserCreate;
+}
+/**
+ * Options for updating a user.
+ */
+export interface UpdateUserOptions {
+    /** User ID */
+    userId: string;
+    /** Changes to apply */
+    changes: UserUpdate;
+}
+/**
+ * Options for granting a role.
+ */
+export interface GrantRoleOptions {
+    /** User ID */
+    userId: string;
+    /** Role to grant */
+    role: string;
+    /** Optional scope for the role (tenant IDs, comma-separated) */
+    scope?: string;
+}
+/**
+ * Options for revoking a role.
+ */
+export interface RevokeRoleOptions {
+    /** User ID */
+    userId: string;
+    /** Role to revoke */
+    role: string;
+    /** Optional scope to remove (if not provided, removes entire role) */
+    scope?: string;
+}
+export { getUser, listUsers, deleteUser, purgeUser, resetUser };
+/**
+ * Retrieves details of a user by login (email).
+ * This searches through paginated results to find the user.
+ *
+ * @param client - Account Manager client
+ * @param login - User login (email)
+ * @returns User details
+ * @throws Error if user is not found
+ */
+export declare function getUserByLogin(client: AccountManagerUsersClient, login: string): Promise<AccountManagerUser>;
+/**
+ * Creates a new user.
+ *
+ * @param client - Account Manager client
+ * @param options - Create options (user details)
+ * @returns Created user
+ */
+export declare function createUser(client: AccountManagerUsersClient, options: CreateUserOptions): Promise<AccountManagerUser>;
+/**
+ * Updates an existing user.
+ *
+ * @param client - Account Manager client
+ * @param options - Update options (userId, changes)
+ * @returns Updated user
+ */
+export declare function updateUser(client: AccountManagerUsersClient, options: UpdateUserOptions): Promise<AccountManagerUser>;
+/**
+ * Grants a role to a user, optionally with scope.
+ * This updates the user's roles and roleTenantFilter.
+ *
+ * @param client - Account Manager client
+ * @param options - Grant options (userId, role, optional scope)
+ * @returns Updated user
+ */
+export declare function grantRole(client: AccountManagerUsersClient, options: GrantRoleOptions): Promise<AccountManagerUser>;
+/**
+ * Revokes a role from a user, optionally removing specific scope.
+ *
+ * @param client - Account Manager client
+ * @param options - Revoke options (userId, role, optional scope)
+ * @returns Updated user
+ */
+export declare function revokeRole(client: AccountManagerUsersClient, options: RevokeRoleOptions): Promise<AccountManagerUser>;
+export type { AccountManagerUser, UserCreate, UserUpdate, UserCollection } from '../../clients/am-api.js';

package/dist/esm/operations/users/index.js

@@ -0,0 +1,141 @@
+import { getUser, listUsers, createUser as createUserApi, updateUser as updateUserApi, deleteUser, purgeUser, resetUser, findUserByLogin, } from '../../clients/am-api.js';
+// Re-export primary API operations from client
+export { getUser, listUsers, deleteUser, purgeUser, resetUser };
+/**
+ * Retrieves details of a user by login (email).
+ * This searches through paginated results to find the user.
+ *
+ * @param client - Account Manager client
+ * @param login - User login (email)
+ * @returns User details
+ * @throws Error if user is not found
+ */
+export async function getUserByLogin(client, login) {
+    const user = await findUserByLogin(client, login);
+    if (!user) {
+        throw new Error(`User ${login} not found`);
+    }
+    return user;
+}
+/**
+ * Creates a new user.
+ *
+ * @param client - Account Manager client
+ * @param options - Create options (user details)
+ * @returns Created user
+ */
+export async function createUser(client, options) {
+    return createUserApi(client, options.user);
+}
+/**
+ * Updates an existing user.
+ *
+ * @param client - Account Manager client
+ * @param options - Update options (userId, changes)
+ * @returns Updated user
+ */
+export async function updateUser(client, options) {
+    return updateUserApi(client, options.userId, options.changes);
+}
+/**
+ * Grants a role to a user, optionally with scope.
+ * This updates the user's roles and roleTenantFilter.
+ *
+ * @param client - Account Manager client
+ * @param options - Grant options (userId, role, optional scope)
+ * @returns Updated user
+ */
+export async function grantRole(client, options) {
+    // First get the current user
+    const user = await getUser(client, options.userId);
+    // Build updated roles
+    const currentRoles = Array.isArray(user.roles)
+        ? user.roles.map((r) => (typeof r === 'string' ? r : r.roleEnumName || ''))
+        : [];
+    const updatedRoles = currentRoles.includes(options.role) ? currentRoles : [...currentRoles, options.role];
+    // Build updated roleTenantFilter
+    let roleTenantFilter = user.roleTenantFilter || '';
+    if (options.scope) {
+        const scopes = options.scope.split(',');
+        // Parse existing filter
+        const filters = roleTenantFilter.split(';').filter(Boolean);
+        const filterMap = new Map();
+        for (const filter of filters) {
+            const [role, tenants] = filter.split(':');
+            if (tenants) {
+                filterMap.set(role, tenants.split(','));
+            }
+        }
+        // Add new scopes
+        const existingScopes = filterMap.get(options.role) || [];
+        const allScopes = [...new Set([...existingScopes, ...scopes])];
+        filterMap.set(options.role, allScopes);
+        // Rebuild filter string
+        roleTenantFilter = Array.from(filterMap.entries())
+            .map(([role, tenants]) => `${role}:${tenants.join(',')}`)
+            .join(';');
+    }
+    return updateUser(client, {
+        userId: options.userId,
+        changes: {
+            roles: updatedRoles,
+            roleTenantFilter: roleTenantFilter || undefined,
+        },
+    });
+}
+/**
+ * Revokes a role from a user, optionally removing specific scope.
+ *
+ * @param client - Account Manager client
+ * @param options - Revoke options (userId, role, optional scope)
+ * @returns Updated user
+ */
+export async function revokeRole(client, options) {
+    // First get the current user
+    const user = await getUser(client, options.userId);
+    // Build updated roles
+    const currentRoles = Array.isArray(user.roles)
+        ? user.roles.map((r) => (typeof r === 'string' ? r : r.roleEnumName || ''))
+        : [];
+    let updatedRoles = currentRoles;
+    // Build updated roleTenantFilter
+    let roleTenantFilter = user.roleTenantFilter || '';
+    if (!options.scope) {
+        // Remove entire role
+        updatedRoles = currentRoles.filter((r) => r !== options.role);
+        // Remove all scopes for this role
+        const filters = roleTenantFilter.split(';').filter(Boolean);
+        roleTenantFilter = filters.filter((f) => !f.startsWith(`${options.role}:`)).join(';');
+    }
+    else {
+        // Remove specific scope
+        const scopes = options.scope.split(',');
+        const filters = roleTenantFilter.split(';').filter(Boolean);
+        const filterMap = new Map();
+        for (const filter of filters) {
+            const [role, tenants] = filter.split(':');
+            if (tenants) {
+                filterMap.set(role, tenants.split(','));
+            }
+        }
+        const existingScopes = filterMap.get(options.role) || [];
+        const updatedScopes = existingScopes.filter((s) => !scopes.includes(s));
+        if (updatedScopes.length > 0) {
+            filterMap.set(options.role, updatedScopes);
+        }
+        else {
+            filterMap.delete(options.role);
+        }
+        roleTenantFilter = Array.from(filterMap.entries())
+            .map(([role, tenants]) => `${role}:${tenants.join(',')}`)
+            .join(';');
+    }
+    return updateUser(client, {
+        userId: options.userId,
+        changes: {
+            roles: updatedRoles.length > 0 ? updatedRoles : undefined,
+            roleTenantFilter: roleTenantFilter || undefined,
+        },
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/operations/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/users/index.ts"],"names":[],"mappings":"AAgEA,OAAO,EACL,OAAO,EACP,SAAS,EACT,UAAU,IAAI,aAAa,EAC3B,UAAU,IAAI,aAAa,EAC3B,UAAU,EACV,SAAS,EACT,SAAS,EACT,eAAe,GAChB,MAAM,yBAAyB,CAAC;AA4CjC,+CAA+C;AAC/C,OAAO,EAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAC,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAiC,EAAE,KAAa;IACnF,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAiC,EACjC,OAA0B;IAE1B,OAAO,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAiC,EACjC,OAA0B;IAE1B,OAAO,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAiC,EACjC,OAAyB;IAEzB,6BAA6B;IAC7B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnD,sBAAsB;IACtB,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1G,iCAAiC;IACjC,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC;IACnD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,wBAAwB;QACxB,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,OAAO,EAAE,CAAC;gBACZ,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QACD,iBAAiB;QACjB,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/D,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACvC,wBAAwB;QACxB,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;aAC/C,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;aACxD,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,EAAE;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE;YACP,KAAK,EAAE,YAAY;YACnB,gBAAgB,EAAE,gBAAgB,IAAI,SAAS;SAChD;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAiC,EACjC,OAA0B;IAE1B,6BAA6B;IAC7B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnD,sBAAsB;IACtB,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,EAAE,CAAC;IACP,IAAI,YAAY,GAAG,YAAY,CAAC;IAEhC,iCAAiC;IACjC,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC;IAEnD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnB,qBAAqB;QACrB,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9D,kCAAkC;QAClC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5D,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxF,CAAC;SAAM,CAAC;QACN,wBAAwB;QACxB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,OAAO,EAAE,CAAC;gBACZ,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QACD,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;aAC/C,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;aACxD,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,EAAE;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE;YACP,KAAK,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YACzD,gBAAgB,EAAE,gBAAgB,IAAI,SAAS;SAChD;KACF,CAAC,CAAC;AACL,CAAC"}