@salesforce/b2c-tooling-sdk 1.9.0 → 1.11.0

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

@@ -1,189 +0,0 @@
-/**
- * Business Manager user operations for B2C Commerce instances.
- *
- * Provides functions for querying and managing instance-level users via OCAPI Data API.
- *
- * Note: Most production B2C Commerce instances delegate user identity to Account Manager
- * (SSO), so creating local Business Manager users via the Data API typically fails with
- * `LocalUserCreationException`. These operations focus on read/search/lifecycle of
- * AM-managed users plus access-key administration.
- */
-import type { B2CInstance } from '../../instance/index.js';
-import type { components } from '../../clients/ocapi.generated.js';
-/**
- * BM user from OCAPI.
- */
-export type BmUser = components['schemas']['user'];
-/**
- * BM users collection from OCAPI.
- */
-export type BmUsers = components['schemas']['users'];
-/**
- * BM user search result from OCAPI.
- */
-export type BmUserSearchResult = components['schemas']['user_search_result'];
-/**
- * Access key details for an externally-managed user.
- */
-export type BmAccessKeyDetails = components['schemas']['access_key_details'];
-/**
- * Valid access-key scopes accepted by the Data API
- * `/users/{login}/access_key/{scope}` endpoints.
- */
-export declare const ACCESS_KEY_SCOPES: readonly ["WEBDAV_AND_STUDIO", "AGENT_USER_AND_OCAPI", "STOREFRONT"];
-/**
- * Access-key scope. One of {@link ACCESS_KEY_SCOPES}.
- */
-export type AccessKeyScope = (typeof ACCESS_KEY_SCOPES)[number];
-/**
- * Updatable user fields for `patch` operations.
- *
- * Note: `locked` and `password` cannot be modified via PATCH per the API spec.
- */
-export interface UpdateBmUserChanges {
-    disabled?: boolean;
-    email?: string;
-    external_id?: string;
-    first_name?: string;
-    last_name?: string;
-    preferred_data_locale?: string;
-    preferred_ui_locale?: string;
-}
-/**
- * Options for listing BM users.
- */
-export interface ListBmUsersOptions {
-    /** Start index (default 0) */
-    start?: number;
-    /** Number of items to return (default 25) */
-    count?: number;
-    /** Property selector (default returns shallow user fields) */
-    select?: string;
-}
-/**
- * Options for searching BM users.
- *
- * Searchable fields per the Data API spec: login, email, first_name, last_name,
- * external_id, last_login_date, is_locked, is_disabled.
- */
-export interface SearchBmUsersOptions {
-    /**
-     * Pre-built OCAPI query object (e.g. `{text_query: {fields: ['login'], search_phrase: 'foo'}}`).
-     * If omitted, one is built from the convenience flags below.
-     */
-    query?: unknown;
-    /** Free-text phrase searched across login/email/first_name/last_name */
-    searchPhrase?: string;
-    /** Match users with a specific login */
-    login?: string;
-    /** Match users with a specific email */
-    email?: string;
-    /** Match locked users */
-    locked?: boolean;
-    /** Match disabled users */
-    disabled?: boolean;
-    /** Field to sort by (e.g. 'login', 'email', 'last_login_date') */
-    sortBy?: string;
-    /** Sort direction */
-    sortOrder?: 'asc' | 'desc';
-    /** Start index (default 0) */
-    start?: number;
-    /** Number of items to return (default 25) */
-    count?: number;
-    /** Property selector (default returns shallow user fields) */
-    select?: string;
-}
-/**
- * Lists all users on a B2C Commerce instance.
- *
- * @param instance - B2C instance to query
- * @param options - Pagination options
- * @returns Users collection with pagination info
- */
-export declare function listBmUsers(instance: B2CInstance, options?: ListBmUsersOptions): Promise<BmUsers>;
-/**
- * Gets a single user by login (email).
- *
- * @param instance - B2C instance
- * @param login - User login
- * @returns User details
- */
-export declare function getBmUser(instance: B2CInstance, login: string): Promise<BmUser>;
-/**
- * Returns details for the currently authenticated user (the user the OAuth token resolves to).
- *
- * Useful for verifying which BM identity is in use on an instance.
- *
- * @param instance - B2C instance
- * @returns Current user details (includes password expiration info)
- */
-export declare function whoamiBmUser(instance: B2CInstance): Promise<BmUser>;
-/**
- * Updates an existing user. The `locked` flag and the user `password` cannot be updated
- * with this resource.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param changes - Fields to update
- * @returns Updated user
- */
-export declare function updateBmUser(instance: B2CInstance, login: string, changes: UpdateBmUserChanges): Promise<BmUser>;
-/**
- * Deletes a user from an instance.
- *
- * @param instance - B2C instance
- * @param login - User login
- */
-export declare function deleteBmUser(instance: B2CInstance, login: string): Promise<void>;
-/**
- * Searches users on an instance.
- *
- * Supports either a fully-formed OCAPI query (`options.query`) or convenience flags
- * (`searchPhrase`, `login`, `email`, `locked`, `disabled`) which are combined into a
- * `bool_query`. If no criteria are provided a `match_all_query` is used.
- *
- * @param instance - B2C instance
- * @param options - Search options
- * @returns User search result
- */
-export declare function searchBmUsers(instance: B2CInstance, options?: SearchBmUsersOptions): Promise<BmUserSearchResult>;
-/**
- * Gets a single access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope (one of {@link ACCESS_KEY_SCOPES})
- * @returns Access key details
- */
-export declare function getBmUserAccessKey(instance: B2CInstance, login: string, scope: string): Promise<BmAccessKeyDetails>;
-/**
- * Creates a single access key for an externally-managed user (replaces any existing key
- * for the same scope).
- *
- * The returned object includes the newly-generated `access_key` value — this is the only
- * time it is returned, so callers should record it.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- * @returns Access key details (including the secret `access_key` value)
- */
-export declare function createBmUserAccessKey(instance: B2CInstance, login: string, scope: string): Promise<BmAccessKeyDetails>;
-/**
- * Enables or disables an existing access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- * @param enabled - Whether the access key should be enabled
- * @returns Updated access key details
- */
-export declare function setBmUserAccessKeyEnabled(instance: B2CInstance, login: string, scope: string, enabled: boolean): Promise<BmAccessKeyDetails>;
-/**
- * Deletes a single access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- */
-export declare function deleteBmUserAccessKey(instance: B2CInstance, login: string, scope: string): Promise<void>;

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

@@ -1,229 +0,0 @@
-import { getApiErrorMessage } from '../../clients/error-utils.js';
-/**
- * Valid access-key scopes accepted by the Data API
- * `/users/{login}/access_key/{scope}` endpoints.
- */
-export const ACCESS_KEY_SCOPES = ['WEBDAV_AND_STUDIO', 'AGENT_USER_AND_OCAPI', 'STOREFRONT'];
-/**
- * Lists all users on a B2C Commerce instance.
- *
- * @param instance - B2C instance to query
- * @param options - Pagination options
- * @returns Users collection with pagination info
- */
-export async function listBmUsers(instance, options = {}) {
-    const { start, count, select } = options;
-    const { data, error, response } = await instance.ocapi.GET('/users', {
-        params: { query: { start, count, select: select ?? '(**)' } },
-    });
-    if (error) {
-        throw new Error(`Failed to list users: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Gets a single user by login (email).
- *
- * @param instance - B2C instance
- * @param login - User login
- * @returns User details
- */
-export async function getBmUser(instance, login) {
-    const { data, error, response } = await instance.ocapi.GET('/users/{login}', {
-        params: { path: { login } },
-    });
-    if (error) {
-        throw new Error(`Failed to get user ${login}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Returns details for the currently authenticated user (the user the OAuth token resolves to).
- *
- * Useful for verifying which BM identity is in use on an instance.
- *
- * @param instance - B2C instance
- * @returns Current user details (includes password expiration info)
- */
-export async function whoamiBmUser(instance) {
-    const { data, error, response } = await instance.ocapi.GET('/users/this');
-    if (error) {
-        throw new Error(`Failed to get current user: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Updates an existing user. The `locked` flag and the user `password` cannot be updated
- * with this resource.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param changes - Fields to update
- * @returns Updated user
- */
-export async function updateBmUser(instance, login, changes) {
-    const { data, error, response } = await instance.ocapi.PATCH('/users/{login}', {
-        params: { path: { login } },
-        body: changes,
-    });
-    if (error) {
-        throw new Error(`Failed to update user ${login}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Deletes a user from an instance.
- *
- * @param instance - B2C instance
- * @param login - User login
- */
-export async function deleteBmUser(instance, login) {
-    const { error, response } = await instance.ocapi.DELETE('/users/{login}', {
-        params: { path: { login } },
-    });
-    if (error) {
-        throw new Error(`Failed to delete user ${login}: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-}
-/**
- * Searches users on an instance.
- *
- * Supports either a fully-formed OCAPI query (`options.query`) or convenience flags
- * (`searchPhrase`, `login`, `email`, `locked`, `disabled`) which are combined into a
- * `bool_query`. If no criteria are provided a `match_all_query` is used.
- *
- * @param instance - B2C instance
- * @param options - Search options
- * @returns User search result
- */
-export async function searchBmUsers(instance, options = {}) {
-    const { query: providedQuery, searchPhrase, login, email, locked, disabled, sortBy, sortOrder, start, count, select, } = options;
-    let query = providedQuery;
-    if (!query) {
-        const queries = [];
-        if (searchPhrase) {
-            queries.push({
-                text_query: {
-                    fields: ['login', 'email', 'first_name', 'last_name'],
-                    search_phrase: searchPhrase,
-                },
-            });
-        }
-        if (login) {
-            queries.push({ term_query: { fields: ['login'], operator: 'is', values: [login] } });
-        }
-        if (email) {
-            queries.push({ term_query: { fields: ['email'], operator: 'is', values: [email] } });
-        }
-        if (locked !== undefined) {
-            queries.push({ term_query: { fields: ['is_locked'], operator: 'is', values: [locked] } });
-        }
-        if (disabled !== undefined) {
-            queries.push({ term_query: { fields: ['is_disabled'], operator: 'is', values: [disabled] } });
-        }
-        if (queries.length === 0) {
-            query = { match_all_query: {} };
-        }
-        else if (queries.length === 1) {
-            query = queries[0];
-        }
-        else {
-            query = { bool_query: { must: queries } };
-        }
-    }
-    const sorts = sortBy ? [{ field: sortBy, sort_order: sortOrder ?? 'asc' }] : undefined;
-    const { data, error, response } = await instance.ocapi.POST('/user_search', {
-        body: {
-            query,
-            start,
-            count,
-            sorts,
-            select: select ?? '(**)',
-        },
-    });
-    if (error) {
-        throw new Error(`Failed to search users: ${getApiErrorMessage(error, response)}`, { cause: error });
-    }
-    return data;
-}
-/**
- * Gets a single access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope (one of {@link ACCESS_KEY_SCOPES})
- * @returns Access key details
- */
-export async function getBmUserAccessKey(instance, login, scope) {
-    const { data, error, response } = await instance.ocapi.GET('/users/{login}/access_key/{scope}', {
-        params: { path: { login, scope } },
-    });
-    if (error) {
-        throw new Error(`Failed to get access key (${scope}) for ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-/**
- * Creates a single access key for an externally-managed user (replaces any existing key
- * for the same scope).
- *
- * The returned object includes the newly-generated `access_key` value — this is the only
- * time it is returned, so callers should record it.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- * @returns Access key details (including the secret `access_key` value)
- */
-export async function createBmUserAccessKey(instance, login, scope) {
-    const { data, error, response } = await instance.ocapi.PUT('/users/{login}/access_key/{scope}', {
-        params: { path: { login, scope } },
-    });
-    if (error) {
-        throw new Error(`Failed to create access key (${scope}) for ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-/**
- * Enables or disables an existing access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- * @param enabled - Whether the access key should be enabled
- * @returns Updated access key details
- */
-export async function setBmUserAccessKeyEnabled(instance, login, scope, enabled) {
-    const { data, error, response } = await instance.ocapi.PATCH('/users/{login}/access_key/{scope}', {
-        params: { path: { login, scope } },
-        body: { enabled },
-    });
-    if (error) {
-        throw new Error(`Failed to update access key (${scope}) for ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-    return data;
-}
-/**
- * Deletes a single access key for an externally-managed user.
- *
- * @param instance - B2C instance
- * @param login - User login
- * @param scope - Access key scope
- */
-export async function deleteBmUserAccessKey(instance, login, scope) {
-    const { error, response } = await instance.ocapi.DELETE('/users/{login}/access_key/{scope}', {
-        params: { path: { login, scope } },
-    });
-    if (error) {
-        throw new Error(`Failed to delete access key (${scope}) for ${login}: ${getApiErrorMessage(error, response)}`, {
-            cause: error,
-        });
-    }
-}
-//# sourceMappingURL=users.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../src/operations/bm-users/users.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAsBhE;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,YAAY,CAAU,CAAC;AAoEtG;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAqB,EAAE,UAA8B,EAAE;IACvF,MAAM,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAEvC,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,IAAI,MAAM,EAAC,EAAC;KAC1D,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;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAqB,EAAE,KAAa;IAClE,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,EAAE;QACzE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC;KACxB,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACzG,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB;IACtD,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAExE,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,+BAA+B,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACxG,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAqB,EACrB,KAAa,EACb,OAA4B;IAE5B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE;QAC3E,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC;QACvB,IAAI,EAAE,OAAwC;KAC/C,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC5G,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,KAAa;IACrE,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC;KACxB,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC5G,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAAqB,EACrB,UAAgC,EAAE;IAElC,MAAM,EACJ,KAAK,EAAE,aAAa,EACpB,YAAY,EACZ,KAAK,EACL,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,EACN,SAAS,EACT,KAAK,EACL,KAAK,EACL,MAAM,GACP,GAAG,OAAO,CAAC;IAEZ,IAAI,KAAK,GAAY,aAAa,CAAC;IACnC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,OAAO,GAAc,EAAE,CAAC;QAE9B,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC;gBACX,UAAU,EAAE;oBACV,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,CAAC;oBACrD,aAAa,EAAE,YAAY;iBAC5B;aACF,CAAC,CAAC;QACL,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,EAAC,EAAC,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,EAAC,EAAC,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAC,EAAC,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,EAAC,MAAM,EAAE,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAC,EAAC,CAAC,CAAC;QAC5F,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,GAAG,EAAC,eAAe,EAAE,EAAE,EAAC,CAAC;QAChC,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,EAAC,UAAU,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,EAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,IAAI,KAAK,EAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE;QACxE,IAAI,EAAE;YACJ,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,MAAM,EAAE,MAAM,IAAI,MAAM;SAC6B;KACxD,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,2BAA2B,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACpG,CAAC;IAED,OAAO,IAA0B,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,QAAqB,EACrB,KAAa,EACb,KAAa;IAEb,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,mCAAmC,EAAE;QAC5F,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAC;KAC/B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC1G,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAA0B,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,QAAqB,EACrB,KAAa,EACb,KAAa;IAEb,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,mCAAmC,EAAE;QAC5F,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAC;KAC/B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC7G,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAA0B,CAAC;AACpC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,QAAqB,EACrB,KAAa,EACb,KAAa,EACb,OAAgB;IAEhB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,mCAAmC,EAAE;QAC9F,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAC;QAC9B,IAAI,EAAE,EAAC,OAAO,EAAuD;KACtE,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC7G,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAA0B,CAAC;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAqB,EAAE,KAAa,EAAE,KAAa;IAC7F,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,mCAAmC,EAAE;QACzF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAC;KAC/B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC7G,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/cjs/operations/cap/index.d.ts

@@ -1,56 +0,0 @@
-/**
- * Commerce App Package (CAP) operations for B2C Commerce.
- *
- * This module provides functions for validating, packaging, installing, and
- * uninstalling Commerce App Packages (CAPs) on B2C Commerce instances.
- *
- * ## CAP Operations
- *
- * - {@link validateCap} - Validate CAP structure and manifest (local, no instance required)
- * - {@link commerceAppInstall} - Install a CAP via the sfcc-install-commerce-app job
- * - {@link commerceAppUninstall} - Uninstall a CAP via the sfcc-uninstall-commerce-app job
- * - {@link commerceAppPackage} - Package a CAP directory into a distributable .zip
- * - {@link discoverLocalApps} - Discover local CAPs by finding commerce-app.json files
- * - {@link listInstalledApps} - List installed apps on an instance via commerce_feature_states export
- *
- * ## Usage
- *
- * ```typescript
- * import {
- *   validateCap,
- *   commerceAppInstall,
- *   commerceAppUninstall,
- *   commerceAppPackage,
- *   discoverLocalApps,
- *   listInstalledApps,
- * } from '@salesforce/b2c-tooling-sdk/operations/cap';
- *
- * // Validate locally
- * const result = await validateCap('./my-commerce-app');
- * if (!result.valid) console.error(result.errors);
- *
- * // Package for distribution
- * const pkg = await commerceAppPackage('./my-commerce-app');
- *
- * // Install on an instance
- * await commerceAppInstall(instance, './my-commerce-app', { siteId: 'RefArch' });
- *
- * // Uninstall
- * await commerceAppUninstall(instance, 'my-app', 'tax', { siteId: 'RefArch' });
- * ```
- *
- * @module operations/cap
- */
-export { validateCap } from './validate.js';
-export type { CapValidationResult, CommerceAppManifest } from './validate.js';
-export { JobExecutionError } from '../jobs/run.js';
-export { commerceAppInstall, readManifest } from './install.js';
-export type { CommerceAppInstallOptions, CommerceAppInstallResult } from './install.js';
-export { commerceAppUninstall } from './uninstall.js';
-export type { CommerceAppUninstallOptions, CommerceAppUninstallResult } from './uninstall.js';
-export { commerceAppPackage } from './package.js';
-export type { CommerceAppPackageOptions, CommerceAppPackageResult } from './package.js';
-export { discoverLocalApps, listInstalledApps, parseCommerceFeatureStatesXml } from './list.js';
-export { pullCommerceApps } from './pull.js';
-export type { PullCommerceAppsOptions, PullCommerceAppsResult, PulledApp, PullSource } from './pull.js';
-export type { CommerceFeatureState, LocalCommerceApp, ListInstalledAppsOptions, ListInstalledAppsResult, } from './list.js';

package/dist/cjs/operations/cap/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
- */
-/**
- * Commerce App Package (CAP) operations for B2C Commerce.
- *
- * This module provides functions for validating, packaging, installing, and
- * uninstalling Commerce App Packages (CAPs) on B2C Commerce instances.
- *
- * ## CAP Operations
- *
- * - {@link validateCap} - Validate CAP structure and manifest (local, no instance required)
- * - {@link commerceAppInstall} - Install a CAP via the sfcc-install-commerce-app job
- * - {@link commerceAppUninstall} - Uninstall a CAP via the sfcc-uninstall-commerce-app job
- * - {@link commerceAppPackage} - Package a CAP directory into a distributable .zip
- * - {@link discoverLocalApps} - Discover local CAPs by finding commerce-app.json files
- * - {@link listInstalledApps} - List installed apps on an instance via commerce_feature_states export
- *
- * ## Usage
- *
- * ```typescript
- * import {
- *   validateCap,
- *   commerceAppInstall,
- *   commerceAppUninstall,
- *   commerceAppPackage,
- *   discoverLocalApps,
- *   listInstalledApps,
- * } from '@salesforce/b2c-tooling-sdk/operations/cap';
- *
- * // Validate locally
- * const result = await validateCap('./my-commerce-app');
- * if (!result.valid) console.error(result.errors);
- *
- * // Package for distribution
- * const pkg = await commerceAppPackage('./my-commerce-app');
- *
- * // Install on an instance
- * await commerceAppInstall(instance, './my-commerce-app', { siteId: 'RefArch' });
- *
- * // Uninstall
- * await commerceAppUninstall(instance, 'my-app', 'tax', { siteId: 'RefArch' });
- * ```
- *
- * @module operations/cap
- */
-export { validateCap } from './validate.js';
-// Re-export JobExecutionError for convenience in CLI commands
-export { JobExecutionError } from '../jobs/run.js';
-export { commerceAppInstall, readManifest } from './install.js';
-export { commerceAppUninstall } from './uninstall.js';
-export { commerceAppPackage } from './package.js';
-export { discoverLocalApps, listInstalledApps, parseCommerceFeatureStatesXml } from './list.js';
-export { pullCommerceApps } from './pull.js';
-//# sourceMappingURL=index.js.map

package/dist/cjs/operations/cap/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/cap/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAG1C,8DAA8D;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EAAC,kBAAkB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAG9D,OAAO,EAAC,oBAAoB,EAAC,MAAM,gBAAgB,CAAC;AAGpD,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAGhD,OAAO,EAAC,iBAAiB,EAAE,iBAAiB,EAAE,6BAA6B,EAAC,MAAM,WAAW,CAAC;AAE9F,OAAO,EAAC,gBAAgB,EAAC,MAAM,WAAW,CAAC"}

package/dist/cjs/operations/cap/install.d.ts

@@ -1,53 +0,0 @@
-import { B2CInstance } from '../../instance/index.js';
-import { type JobExecution, type WaitForJobOptions } from '../jobs/run.js';
-import { type CommerceAppManifest } from './validate.js';
-/**
- * Options for CAP installation.
- */
-export interface CommerceAppInstallOptions {
-    /** Target site ID to install the app on. */
-    siteId: string;
-    /** Keep the uploaded zip on the instance after install (default: false). */
-    keepArchive?: boolean;
-    /** Wait options for job completion. */
-    waitOptions?: WaitForJobOptions;
-}
-/**
- * Result of a CAP installation.
- */
-export interface CommerceAppInstallResult {
-    /** Job execution details. */
-    execution: JobExecution;
-    /** App name (id from commerce-app.json). */
-    appName: string;
-    /** App version. */
-    appVersion: string;
-    /** Uploaded archive filename. */
-    archiveFilename: string;
-    /** Whether the archive was kept on the instance. */
-    archiveKept: boolean;
-}
-/**
- * Installs a Commerce App Package (CAP) on a B2C Commerce instance.
- *
- * Accepts a local directory or zip file. Reads the commerce-app.json manifest
- * to determine app name, version, and domain. Uploads the zip to WebDAV and
- * executes the sfcc-install-commerce-app system job.
- *
- * @param instance - B2C instance to install to
- * @param target - Path to a CAP directory or .zip file
- * @param options - Install options including required siteId
- * @returns Install result with job execution details
- * @throws JobExecutionError if the install job fails
- *
- * @example
- * ```typescript
- * const result = await commerceAppInstall(instance, './commerce-avalara-tax-app-v0.2.5', {
- *   siteId: 'RefArch',
- * });
- * ```
- */
-export declare function commerceAppInstall(instance: B2CInstance, target: string, options: CommerceAppInstallOptions): Promise<CommerceAppInstallResult>;
-export declare function readManifest(capDir: string): CommerceAppManifest;
-/** Prefix site ID with "Sites-" if not already present. */
-export declare function normalizeSiteId(siteId: string): string;