@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/logging/logger.js

@@ -1,138 +0,0 @@
-/*
- * 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
- */
-/**
- * Logger using pino with pretty printing by default.
- */
-import { Writable } from 'node:stream';
-import pino from 'pino';
-import pretty from 'pino-pretty';
-const REDACT_FIELDS = [
-    'password',
-    'client_secret',
-    'clientSecret',
-    'access_token',
-    'accessToken',
-    'refresh_token',
-    'refreshToken',
-    'api_key',
-    'apiKey',
-    'token',
-    'secret',
-    'authorization',
-    'Authorization',
-];
-const REDACT_PATHS = REDACT_FIELDS.flatMap((field) => [field, `*.${field}`]);
-function censor(value, path) {
-    // Special handling for authorization headers
-    if (path[path.length - 1].toLowerCase() === 'authorization' && typeof value === 'string') {
-        const parts = value.split(' ');
-        if (parts.length === 2) {
-            const [scheme, credentials] = parts;
-            // For Basic auth, decode, redact password, and re-encode
-            if (scheme.toLowerCase() === 'basic') {
-                try {
-                    const decoded = Buffer.from(credentials, 'base64').toString('utf-8');
-                    const colonIndex = decoded.indexOf(':');
-                    if (colonIndex !== -1) {
-                        const username = decoded.slice(0, colonIndex);
-                        const redacted = Buffer.from(`${username}:REDACTED`).toString('base64');
-                        return `Basic ${redacted}`;
-                    }
-                }
-                catch {
-                    // If decoding fails, fall through to default behavior
-                }
-            }
-            // For other schemes (Bearer, etc.), show scheme and partial token
-            return `${scheme} ${credentials.slice(0, 6)}...REDACTED`;
-        }
-    }
-    if (typeof value === 'string' && value.length > 10) {
-        return `${value.slice(0, 4)}...REDACTED`;
-    }
-    return 'REDACTED';
-}
-/** Wrap a minimal LogDestination in a Node.js Writable so pino-pretty's transport pipeline works. */
-function toWritable(dest) {
-    if (dest instanceof Writable)
-        return dest;
-    return new Writable({
-        write(chunk, _encoding, callback) {
-            dest.write(chunk);
-            callback();
-        },
-    });
-}
-let globalLogger = null;
-let globalOptions = { level: 'silent' };
-function createPinoLogger(options) {
-    const level = options.level ?? 'info';
-    const fd = options.fd ?? 2; // Default to stderr
-    const colorize = options.colorize ?? true;
-    const pinoOptions = {
-        level,
-        base: options.baseContext ?? {},
-        formatters: {
-            level: (label) => ({ level: label }),
-        },
-    };
-    if (options.redact !== false) {
-        pinoOptions.redact = {
-            paths: REDACT_PATHS,
-            censor,
-        };
-    }
-    // Custom destination stream (for testing)
-    if (options.destination) {
-        if (options.json) {
-            return pino(pinoOptions, options.destination);
-        }
-        const isVerbose = level === 'debug' || level === 'trace';
-        const prettyStream = pretty({
-            destination: toWritable(options.destination),
-            sync: true,
-            colorize,
-            ignore: 'pid,hostname' + (isVerbose ? '' : ',time'),
-            hideObject: !isVerbose,
-        });
-        return pino(pinoOptions, prettyStream);
-    }
-    // JSON output
-    if (options.json) {
-        return pino(pinoOptions, pino.destination({ fd, sync: true }));
-    }
-    // Pretty print (default)
-    const isVerbose = level === 'debug' || level === 'trace';
-    const prettyStream = pretty({
-        destination: fd,
-        sync: true,
-        colorize,
-        ignore: 'pid,hostname' + (isVerbose ? '' : ',time'),
-        hideObject: !isVerbose,
-    });
-    return pino(pinoOptions, prettyStream);
-}
-export function createLogger(options = {}) {
-    return createPinoLogger({ ...globalOptions, ...options });
-}
-export function configureLogger(options) {
-    globalOptions = { ...globalOptions, ...options };
-    globalLogger = createPinoLogger(globalOptions);
-}
-export function getLogger() {
-    if (!globalLogger) {
-        globalLogger = createPinoLogger(globalOptions);
-    }
-    return globalLogger;
-}
-export function resetLogger() {
-    globalLogger = null;
-    globalOptions = { level: 'silent' };
-}
-export function createSilentLogger() {
-    return createLogger({ level: 'silent' });
-}
-//# sourceMappingURL=logger.js.map

package/dist/cjs/logging/logger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/logging/logger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;GAEG;AAEH,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,MAAM,MAAM,aAAa,CAAC;AAGjC,MAAM,aAAa,GAAG;IACpB,UAAU;IACV,eAAe;IACf,cAAc;IACd,cAAc;IACd,aAAa;IACb,eAAe;IACf,cAAc;IACd,SAAS;IACT,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,eAAe;IACf,eAAe;CAChB,CAAC;AAEF,MAAM,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;AAE7E,SAAS,MAAM,CAAC,KAAc,EAAE,IAAc;IAC5C,6CAA6C;IAC7C,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,eAAe,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACzF,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,KAAK,CAAC;YAEpC,yDAAyD;YACzD,IAAI,MAAM,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;gBACrC,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;oBACrE,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACxC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;wBACtB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;wBAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,WAAW,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;wBACxE,OAAO,SAAS,QAAQ,EAAE,CAAC;oBAC7B,CAAC;gBACH,CAAC;gBAAC,MAAM,CAAC;oBACP,sDAAsD;gBACxD,CAAC;YACH,CAAC;YAED,kEAAkE;YAClE,OAAO,GAAG,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACnD,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC;IAC3C,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,qGAAqG;AACrG,SAAS,UAAU,CAAC,IAAoB;IACtC,IAAI,IAAI,YAAY,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC1C,OAAO,IAAI,QAAQ,CAAC;QAClB,KAAK,CAAC,KAAa,EAAE,SAAyB,EAAE,QAAwC;YACtF,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClB,QAAQ,EAAE,CAAC;QACb,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,IAAI,YAAY,GAAkB,IAAI,CAAC;AACvC,IAAI,aAAa,GAAkB,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC;AAErD,SAAS,gBAAgB,CAAC,OAAsB;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC;IACtC,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,oBAAoB;IAChD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IAE1C,MAAM,WAAW,GAAuB;QACtC,KAAK;QACL,IAAI,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;QAC/B,UAAU,EAAE;YACV,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC;SACnC;KACF,CAAC;IAEF,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC7B,WAAW,CAAC,MAAM,GAAG;YACnB,KAAK,EAAE,YAAY;YACnB,MAAM;SACP,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAsB,CAAC;QACrE,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,CAAC;QACzD,MAAM,YAAY,GAAG,MAAM,CAAC;YAC1B,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI;YACV,QAAQ;YACR,MAAM,EAAE,cAAc,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,UAAU,EAAE,CAAC,SAAS;SACvB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACzC,CAAC;IAED,cAAc;IACd,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC,CAAsB,CAAC;IACpF,CAAC;IAED,yBAAyB;IACzB,MAAM,SAAS,GAAG,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,CAAC;IACzD,MAAM,YAAY,GAAG,MAAM,CAAC;QAC1B,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,IAAI;QACV,QAAQ;QACR,MAAM,EAAE,cAAc,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QACnD,UAAU,EAAE,CAAC,SAAS;KACvB,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAyB,EAAE;IACtD,OAAO,gBAAgB,CAAC,EAAC,GAAG,aAAa,EAAE,GAAG,OAAO,EAAC,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAsB;IACpD,aAAa,GAAG,EAAC,GAAG,aAAa,EAAE,GAAG,OAAO,EAAC,CAAC;IAC/C,YAAY,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,YAAY,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,WAAW;IACzB,YAAY,GAAG,IAAI,CAAC;IACpB,aAAa,GAAG,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,OAAO,YAAY,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;AACzC,CAAC"}

package/dist/cjs/logging/types.d.ts

@@ -1,45 +0,0 @@
-/**
- * Logging types.
- */
-export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'silent';
-export interface LogContext {
-    [key: string]: unknown;
-}
-/** Writable stream interface for custom log destinations (Node.js Writable compatible) */
-export interface LogDestination {
-    write(chunk: string | Buffer, encoding?: BufferEncoding, callback?: (error?: Error | null) => void): boolean;
-    on?(event: string, listener: (...args: unknown[]) => void): this;
-    once?(event: string, listener: (...args: unknown[]) => void): this;
-    emit?(event: string, ...args: unknown[]): boolean;
-}
-export interface LoggerOptions {
-    /** Log level. Default: 'info' */
-    level?: LogLevel;
-    /** File descriptor to write to (1=stdout, 2=stderr). Default: 2 */
-    fd?: number;
-    /** Custom destination stream. Overrides fd when provided. Useful for testing. */
-    destination?: LogDestination;
-    /** Base context included in all log entries */
-    baseContext?: LogContext;
-    /** Enable secret redaction. Default: true */
-    redact?: boolean;
-    /** Output JSON lines instead of pretty print. Default: false */
-    json?: boolean;
-    /** Enable colors in pretty print mode. Default: true */
-    colorize?: boolean;
-}
-export interface Logger {
-    trace(message: string, context?: LogContext): void;
-    trace(context: LogContext, message: string): void;
-    debug(message: string, context?: LogContext): void;
-    debug(context: LogContext, message: string): void;
-    info(message: string, context?: LogContext): void;
-    info(context: LogContext, message: string): void;
-    warn(message: string, context?: LogContext): void;
-    warn(context: LogContext, message: string): void;
-    error(message: string, context?: LogContext): void;
-    error(context: LogContext, message: string): void;
-    fatal(message: string, context?: LogContext): void;
-    fatal(context: LogContext, message: string): void;
-    child(context: LogContext): Logger;
-}

package/dist/cjs/logging/types.js

@@ -1,10 +0,0 @@
-/*
- * 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
- */
-/**
- * Logging types.
- */
-export {};
-//# sourceMappingURL=types.js.map

package/dist/cjs/logging/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/logging/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;GAEG"}

package/dist/cjs/operations/bm-roles/index.d.ts

@@ -1,52 +0,0 @@
-/**
- * Business Manager role operations for B2C Commerce instances.
- *
- * This module provides functions for managing instance-level access roles
- * on B2C Commerce instances via the OCAPI Data API. These are distinct from
- * Account Manager roles managed via {@link @salesforce/b2c-tooling-sdk/operations/roles | operations/roles}.
- *
- * ## Core Role Functions
- *
- * - {@link listBmRoles} - List all access roles on an instance
- * - {@link getBmRole} - Get role details with optional expansion
- * - {@link createBmRole} - Create a new access role
- * - {@link deleteBmRole} - Delete an access role
- *
- * ## User Assignment
- *
- * - {@link grantBmRole} - Assign a user to a role
- * - {@link revokeBmRole} - Unassign a user from a role
- *
- * ## Permissions
- *
- * - {@link getBmRolePermissions} - Get permissions for a role
- * - {@link setBmRolePermissions} - Replace all permissions for a role
- *
- * ## Usage
- *
- * ```typescript
- * import {listBmRoles, grantBmRole, getBmRolePermissions} from '@salesforce/b2c-tooling-sdk/operations/bm-roles';
- * import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';
- *
- * const config = resolveConfig();
- * const instance = config.createB2CInstance();
- *
- * // List all roles
- * const roles = await listBmRoles(instance);
- *
- * // Grant a role to a user
- * await grantBmRole(instance, 'Administrator', 'user@example.com');
- *
- * // Get permissions for a role
- * const permissions = await getBmRolePermissions(instance, 'Administrator');
- * ```
- *
- * ## Authentication
- *
- * BM role operations require OAuth authentication with appropriate OCAPI permissions
- * for the `/roles` resource.
- *
- * @module operations/bm-roles
- */
-export { listBmRoles, getBmRole, createBmRole, deleteBmRole, grantBmRole, revokeBmRole, getBmRolePermissions, setBmRolePermissions, } from './roles.js';
-export type { BmRole, BmRoles, BmRolePermissions, ListBmRolesOptions, GetBmRoleOptions } from './roles.js';

package/dist/cjs/operations/bm-roles/index.js

@@ -1,57 +0,0 @@
-/*
- * 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
- */
-/**
- * Business Manager role operations for B2C Commerce instances.
- *
- * This module provides functions for managing instance-level access roles
- * on B2C Commerce instances via the OCAPI Data API. These are distinct from
- * Account Manager roles managed via {@link @salesforce/b2c-tooling-sdk/operations/roles | operations/roles}.
- *
- * ## Core Role Functions
- *
- * - {@link listBmRoles} - List all access roles on an instance
- * - {@link getBmRole} - Get role details with optional expansion
- * - {@link createBmRole} - Create a new access role
- * - {@link deleteBmRole} - Delete an access role
- *
- * ## User Assignment
- *
- * - {@link grantBmRole} - Assign a user to a role
- * - {@link revokeBmRole} - Unassign a user from a role
- *
- * ## Permissions
- *
- * - {@link getBmRolePermissions} - Get permissions for a role
- * - {@link setBmRolePermissions} - Replace all permissions for a role
- *
- * ## Usage
- *
- * ```typescript
- * import {listBmRoles, grantBmRole, getBmRolePermissions} from '@salesforce/b2c-tooling-sdk/operations/bm-roles';
- * import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';
- *
- * const config = resolveConfig();
- * const instance = config.createB2CInstance();
- *
- * // List all roles
- * const roles = await listBmRoles(instance);
- *
- * // Grant a role to a user
- * await grantBmRole(instance, 'Administrator', 'user@example.com');
- *
- * // Get permissions for a role
- * const permissions = await getBmRolePermissions(instance, 'Administrator');
- * ```
- *
- * ## Authentication
- *
- * BM role operations require OAuth authentication with appropriate OCAPI permissions
- * for the `/roles` resource.
- *
- * @module operations/bm-roles
- */
-export { listBmRoles, getBmRole, createBmRole, deleteBmRole, grantBmRole, revokeBmRole, getBmRolePermissions, setBmRolePermissions, } from './roles.js';
-//# sourceMappingURL=index.js.map

package/dist/cjs/operations/bm-roles/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,OAAO,EACL,WAAW,EACX,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,YAAY,CAAC"}

package/dist/cjs/operations/bm-roles/roles.d.ts

@@ -1,155 +0,0 @@
-/**
- * Business Manager role operations for B2C Commerce instances.
- *
- * Provides functions for managing instance-level access roles via OCAPI Data API.
- */
-import type { B2CInstance } from '../../instance/index.js';
-import type { components } from '../../clients/ocapi.generated.js';
-/**
- * BM access role from OCAPI.
- */
-export type BmRole = components['schemas']['role'];
-/**
- * BM access roles collection from OCAPI.
- */
-export type BmRoles = components['schemas']['roles'];
-/**
- * BM role permissions from OCAPI.
- */
-export type BmRolePermissions = components['schemas']['role_permissions'];
-/**
- * Options for listing BM roles.
- */
-export interface ListBmRolesOptions {
-    /** Start index (default 0) */
-    start?: number;
-    /** Number of items to return (default 25) */
-    count?: number;
-}
-/**
- * Options for getting a BM role.
- */
-export interface GetBmRoleOptions {
-    /** Expansions to apply (e.g. 'users', 'permissions') */
-    expand?: string[];
-}
-/**
- * Lists all access roles on a B2C Commerce instance.
- *
- * @param instance - B2C instance to query
- * @param options - Pagination options
- * @returns Roles collection with pagination info
- *
- * @example
- * ```typescript
- * const roles = await listBmRoles(instance);
- * for (const role of roles.data ?? []) {
- *   console.log(role.id, role.description);
- * }
- * ```
- */
-export declare function listBmRoles(instance: B2CInstance, options?: ListBmRolesOptions): Promise<BmRoles>;
-/**
- * Gets details of a specific access role.
- *
- * @param instance - B2C instance to query
- * @param roleId - Role ID (e.g. "Administrator")
- * @param options - Expand options
- * @returns Role details
- *
- * @example
- * ```typescript
- * const role = await getBmRole(instance, 'Administrator', { expand: ['users'] });
- * console.log(role.id, role.user_count);
- * ```
- */
-export declare function getBmRole(instance: B2CInstance, roleId: string, options?: GetBmRoleOptions): Promise<BmRole>;
-/**
- * Creates a new access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to create
- * @param role - Role properties (description, etc.)
- * @returns Created role
- *
- * @example
- * ```typescript
- * const role = await createBmRole(instance, 'MyCustomRole', { description: 'A custom role' });
- * ```
- */
-export declare function createBmRole(instance: B2CInstance, roleId: string, role?: {
-    description?: string;
-}): Promise<BmRole>;
-/**
- * Deletes an access role from an instance.
- *
- * System roles (e.g. "Administrator", "Support") cannot be deleted.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to delete
- *
- * @example
- * ```typescript
- * await deleteBmRole(instance, 'MyCustomRole');
- * ```
- */
-export declare function deleteBmRole(instance: B2CInstance, roleId: string): Promise<void>;
-/**
- * Assigns a user to an access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to grant
- * @param login - User login (email)
- * @returns The user object after assignment
- *
- * @example
- * ```typescript
- * const user = await grantBmRole(instance, 'Administrator', 'user@example.com');
- * ```
- */
-export declare function grantBmRole(instance: B2CInstance, roleId: string, login: string): Promise<components['schemas']['user']>;
-/**
- * Unassigns a user from an access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to revoke
- * @param login - User login (email)
- *
- * @example
- * ```typescript
- * await revokeBmRole(instance, 'Administrator', 'user@example.com');
- * ```
- */
-export declare function revokeBmRole(instance: B2CInstance, roleId: string, login: string): Promise<void>;
-/**
- * Gets permissions assigned to an access role.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID
- * @returns Role permissions object
- *
- * @example
- * ```typescript
- * const permissions = await getBmRolePermissions(instance, 'Administrator');
- * console.log(permissions.functional?.organization?.length);
- * ```
- */
-export declare function getBmRolePermissions(instance: B2CInstance, roleId: string): Promise<BmRolePermissions>;
-/**
- * Sets (replaces) all permissions for an access role.
- *
- * This is a full replacement — all existing permissions are replaced with the provided set.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID
- * @param permissions - Complete permissions object
- * @returns Updated permissions
- *
- * @example
- * ```typescript
- * const perms = await getBmRolePermissions(instance, 'MyRole');
- * // ... modify perms ...
- * await setBmRolePermissions(instance, 'MyRole', perms);
- * ```
- */
-export declare function setBmRolePermissions(instance: B2CInstance, roleId: string, permissions: BmRolePermissions): Promise<BmRolePermissions>;

package/dist/cjs/operations/bm-roles/roles.js

@@ -1,194 +0,0 @@
-import { getApiErrorMessage } from '../../clients/error-utils.js';
-/**
- * Lists all access roles on a B2C Commerce instance.
- *
- * @param instance - B2C instance to query
- * @param options - Pagination options
- * @returns Roles collection with pagination info
- *
- * @example
- * ```typescript
- * const roles = await listBmRoles(instance);
- * for (const role of roles.data ?? []) {
- *   console.log(role.id, role.description);
- * }
- * ```
- */
-export async function listBmRoles(instance, options = {}) {
-    const { start, count } = options;
-    const { data, error, response } = await instance.ocapi.GET('/roles', {
-        params: { query: { start, count, select: '(**)' } },
-    });
-    if (error) {
-        throw new Error(`Failed to list roles: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Gets details of a specific access role.
- *
- * @param instance - B2C instance to query
- * @param roleId - Role ID (e.g. "Administrator")
- * @param options - Expand options
- * @returns Role details
- *
- * @example
- * ```typescript
- * const role = await getBmRole(instance, 'Administrator', { expand: ['users'] });
- * console.log(role.id, role.user_count);
- * ```
- */
-export async function getBmRole(instance, roleId, options = {}) {
-    const { expand } = options;
-    const { data, error, response } = await instance.ocapi.GET('/roles/{id}', {
-        params: { path: { id: roleId }, query: { expand } },
-    });
-    if (error) {
-        throw new Error(`Failed to get role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Creates a new access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to create
- * @param role - Role properties (description, etc.)
- * @returns Created role
- *
- * @example
- * ```typescript
- * const role = await createBmRole(instance, 'MyCustomRole', { description: 'A custom role' });
- * ```
- */
-export async function createBmRole(instance, roleId, role = {}) {
-    const { data, error, response } = await instance.ocapi.PUT('/roles/{id}', {
-        params: { path: { id: roleId } },
-        body: { id: roleId, ...role },
-    });
-    if (error) {
-        throw new Error(`Failed to create role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Deletes an access role from an instance.
- *
- * System roles (e.g. "Administrator", "Support") cannot be deleted.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to delete
- *
- * @example
- * ```typescript
- * await deleteBmRole(instance, 'MyCustomRole');
- * ```
- */
-export async function deleteBmRole(instance, roleId) {
-    const { error, response } = await instance.ocapi.DELETE('/roles/{id}', {
-        params: { path: { id: roleId } },
-    });
-    if (error) {
-        throw new Error(`Failed to delete role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-}
-/**
- * Assigns a user to an access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to grant
- * @param login - User login (email)
- * @returns The user object after assignment
- *
- * @example
- * ```typescript
- * const user = await grantBmRole(instance, 'Administrator', 'user@example.com');
- * ```
- */
-export async function grantBmRole(instance, roleId, login) {
-    const { data, error, response } = await instance.ocapi.PUT('/roles/{id}/users/{login}', {
-        params: { path: { id: roleId, login } },
-    });
-    if (error) {
-        throw new Error(`Failed to grant role ${roleId} to ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-/**
- * Unassigns a user from an access role on an instance.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID to revoke
- * @param login - User login (email)
- *
- * @example
- * ```typescript
- * await revokeBmRole(instance, 'Administrator', 'user@example.com');
- * ```
- */
-export async function revokeBmRole(instance, roleId, login) {
-    const { error, response } = await instance.ocapi.DELETE('/roles/{id}/users/{login}', {
-        params: { path: { id: roleId, login } },
-    });
-    if (error) {
-        throw new Error(`Failed to revoke role ${roleId} from ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-}
-/**
- * Gets permissions assigned to an access role.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID
- * @returns Role permissions object
- *
- * @example
- * ```typescript
- * const permissions = await getBmRolePermissions(instance, 'Administrator');
- * console.log(permissions.functional?.organization?.length);
- * ```
- */
-export async function getBmRolePermissions(instance, roleId) {
-    const { data, error, response } = await instance.ocapi.GET('/roles/{id}/permissions', {
-        params: { path: { id: roleId } },
-    });
-    if (error) {
-        throw new Error(`Failed to get permissions for role ${roleId}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-/**
- * Sets (replaces) all permissions for an access role.
- *
- * This is a full replacement — all existing permissions are replaced with the provided set.
- *
- * @param instance - B2C instance
- * @param roleId - Role ID
- * @param permissions - Complete permissions object
- * @returns Updated permissions
- *
- * @example
- * ```typescript
- * const perms = await getBmRolePermissions(instance, 'MyRole');
- * // ... modify perms ...
- * await setBmRolePermissions(instance, 'MyRole', perms);
- * ```
- */
-export async function setBmRolePermissions(instance, roleId, permissions) {
-    const { data, error, response } = await instance.ocapi.PUT('/roles/{id}/permissions', {
-        params: { path: { id: roleId } },
-        body: permissions,
-    });
-    if (error) {
-        throw new Error(`Failed to set permissions for role ${roleId}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-//# sourceMappingURL=roles.js.map

package/dist/cjs/operations/bm-roles/roles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/roles.ts"],"names":[],"mappings":"AAYA,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAmChE;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAqB,EAAE,UAA8B,EAAE;IACvF,MAAM,EAAC,KAAK,EAAE,KAAK,EAAC,GAAG,OAAO,CAAC;IAE/B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjE,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAC,EAAC;KAChD,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAClG,CAAC;IAED,OAAO,IAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,QAAqB,EACrB,MAAc,EACd,UAA4B,EAAE;IAE9B,MAAM,EAAC,MAAM,EAAC,GAAG,OAAO,CAAC;IAEzB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAC,EAAC;KAC9C,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC1G,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAqB,EACrB,MAAc,EACd,OAA+B,EAAE;IAEjC,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAkC;KAC7D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc;IACtE,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE;QACnE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC7G,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAAqB,EACrB,MAAc,EACd,KAAa;IAEb,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,EAAE;QACpF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,OAAO,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACpG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAqC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc,EAAE,KAAa;IACrF,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,2BAA2B,EAAE;QACjF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACvG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,QAAqB,EAAE,MAAc;IAC9E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAqB,EACrB,MAAc,EACd,WAA8B;IAE9B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,WAAwD;KAC/D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC"}