@salesforce/b2c-tooling-sdk 1.9.0 → 1.11.0

package/dist/cjs/docs/download.d.ts

@@ -1,45 +0,0 @@
-import type { B2CInstance } from '../instance/index.js';
-/**
- * Options for downloading documentation.
- */
-export interface DownloadDocsOptions {
-    /** Output directory for extracted docs */
-    outputDir: string;
-    /** Keep the downloaded archive file (default: false) */
-    keepArchive?: boolean;
-}
-/**
- * Result of a documentation download.
- */
-export interface DownloadDocsResult {
-    /** Path where docs were extracted */
-    outputPath: string;
-    /** Number of files extracted */
-    fileCount: number;
-    /** Archive filename if kept */
-    archivePath?: string;
-}
-/**
- * Downloads documentation archive from a B2C instance.
- *
- * The archive is available at a special URL:
- * `https://{hostname}:443/on/demandware.servlet/WFS/Studio/Sites/mock/demandware-mock.zip`
- *
- * The outer zip contains `DWAPP-*.API-doc.zip` which contains `sfdocs/script-api/` with markdown docs.
- *
- * @param instance - B2C instance to download from
- * @param options - Download options
- * @returns Download result with extraction details
- * @throws Error if download fails or credentials are missing
- *
- * @example
- * ```typescript
- * const instance = B2CInstance.fromEnvironment();
- * const result = await downloadDocs(instance, {
- *   outputDir: './docs',
- *   keepArchive: true,
- * });
- * console.log(`Downloaded ${result.fileCount} files`);
- * ```
- */
-export declare function downloadDocs(instance: B2CInstance, options: DownloadDocsOptions): Promise<DownloadDocsResult>;

package/dist/cjs/docs/download.js

@@ -1,96 +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
- */
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import JSZip from 'jszip';
-import { BasicAuthStrategy } from '../auth/basic.js';
-import { getLogger } from '../logging/logger.js';
-/**
- * Downloads documentation archive from a B2C instance.
- *
- * The archive is available at a special URL:
- * `https://{hostname}:443/on/demandware.servlet/WFS/Studio/Sites/mock/demandware-mock.zip`
- *
- * The outer zip contains `DWAPP-*.API-doc.zip` which contains `sfdocs/script-api/` with markdown docs.
- *
- * @param instance - B2C instance to download from
- * @param options - Download options
- * @returns Download result with extraction details
- * @throws Error if download fails or credentials are missing
- *
- * @example
- * ```typescript
- * const instance = B2CInstance.fromEnvironment();
- * const result = await downloadDocs(instance, {
- *   outputDir: './docs',
- *   keepArchive: true,
- * });
- * console.log(`Downloaded ${result.fileCount} files`);
- * ```
- */
-export async function downloadDocs(instance, options) {
-    const logger = getLogger();
-    const { outputDir, keepArchive = false } = options;
-    // Require basic auth for this endpoint
-    if (!instance.auth.basic) {
-        throw new Error('WebDAV credentials (username/password) required for docs download');
-    }
-    const authStrategy = new BasicAuthStrategy(instance.auth.basic.username, instance.auth.basic.password);
-    // Build the special docs URL (not standard WebDAV path)
-    const hostname = instance.config.webdavHostname || instance.config.hostname;
-    const docsUrl = `https://${hostname}:443/on/demandware.servlet/WFS/Studio/Sites/mock/demandware-mock.zip`;
-    logger.debug({ url: docsUrl }, 'Downloading documentation archive');
-    const response = await authStrategy.fetch(docsUrl);
-    if (!response.ok) {
-        throw new Error(`Failed to download docs: ${response.status} ${response.statusText}`);
-    }
-    const outerZipBuffer = Buffer.from(await response.arrayBuffer());
-    logger.debug({ size: outerZipBuffer.length }, 'Downloaded outer archive');
-    // Extract outer zip to find DWAPP-*.API-doc.zip
-    const outerZip = await JSZip.loadAsync(outerZipBuffer);
-    // Find the API doc zip file
-    const apiDocEntry = Object.keys(outerZip.files).find((name) => name.match(/DWAPP-.*API-doc\.zip$/i));
-    if (!apiDocEntry) {
-        throw new Error('API documentation archive not found in downloaded package');
-    }
-    logger.debug({ entry: apiDocEntry }, 'Found API documentation archive');
-    // Extract inner zip content
-    const innerZipBuffer = await outerZip.files[apiDocEntry].async('nodebuffer');
-    const innerZip = await JSZip.loadAsync(innerZipBuffer);
-    // Create output directory
-    await fs.promises.mkdir(outputDir, { recursive: true });
-    // Extract sfdocs/script-api/*.md files (flat, no subdirectories)
-    let fileCount = 0;
-    const scriptApiPrefix = 'sfdocs/script-api/';
-    for (const [relativePath, zipEntry] of Object.entries(innerZip.files)) {
-        if (!relativePath.startsWith(scriptApiPrefix) || zipEntry.dir) {
-            continue;
-        }
-        // Only extract .md files
-        if (!relativePath.endsWith('.md')) {
-            continue;
-        }
-        // Get just the filename (strip the prefix)
-        const filename = relativePath.slice(scriptApiPrefix.length);
-        const outputPath = path.join(outputDir, filename);
-        const content = await zipEntry.async('nodebuffer');
-        await fs.promises.writeFile(outputPath, content);
-        fileCount++;
-    }
-    logger.debug({ fileCount }, 'Extracted documentation files');
-    const result = {
-        outputPath: outputDir,
-        fileCount,
-    };
-    if (keepArchive) {
-        const archivePath = path.join(outputDir, 'demandware-mock.zip');
-        await fs.promises.writeFile(archivePath, outerZipBuffer);
-        result.archivePath = archivePath;
-        logger.debug({ archivePath }, 'Saved archive');
-    }
-    return result;
-}
-//# sourceMappingURL=download.js.map

package/dist/cjs/docs/download.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"download.js","sourceRoot":"","sources":["../../../src/docs/download.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,iBAAiB,EAAC,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAwB/C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,OAA4B;IACpF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,SAAS,EAAE,WAAW,GAAG,KAAK,EAAC,GAAG,OAAO,CAAC;IAEjD,uCAAuC;IACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEvG,wDAAwD;IACxD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,cAAc,IAAI,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC5E,MAAM,OAAO,GAAG,WAAW,QAAQ,sEAAsE,CAAC;IAE1G,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAE,OAAO,EAAC,EAAE,mCAAmC,CAAC,CAAC;IAElE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEnD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IACjE,MAAM,CAAC,KAAK,CAAC,EAAC,IAAI,EAAE,cAAc,CAAC,MAAM,EAAC,EAAE,0BAA0B,CAAC,CAAC;IAExE,gDAAgD;IAChD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAEvD,4BAA4B;IAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAErG,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,WAAW,EAAC,EAAE,iCAAiC,CAAC,CAAC;IAEtE,4BAA4B;IAC5B,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC7E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAEvD,0BAA0B;IAC1B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAEtD,iEAAiE;IACjE,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,eAAe,GAAG,oBAAoB,CAAC;IAE7C,KAAK,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC9D,SAAS;QACX,CAAC;QAED,yBAAyB;QACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,SAAS;QACX,CAAC;QAED,2CAA2C;QAC3C,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACnD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACjD,SAAS,EAAE,CAAC;IACd,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,SAAS,EAAC,EAAE,+BAA+B,CAAC,CAAC;IAE3D,MAAM,MAAM,GAAuB;QACjC,UAAU,EAAE,SAAS;QACrB,SAAS;KACV,CAAC;IAEF,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;QAChE,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,eAAe,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/cjs/docs/index.d.ts

@@ -1,44 +0,0 @@
-/**
- * Documentation search for B2C Commerce Script API.
- *
- * Provides functions for downloading documentation from B2C instances
- * and searching bundled documentation locally.
- *
- * ## Download Documentation
- *
- * Use {@link downloadDocs} to download documentation from a B2C instance:
- *
- * ```typescript
- * import { downloadDocs } from '@salesforce/b2c-tooling-sdk/docs';
- * import { B2CInstance } from '@salesforce/b2c-tooling-sdk';
- *
- * const instance = B2CInstance.fromEnvironment();
- * const result = await downloadDocs(instance, { outputDir: './docs' });
- * console.log(`Downloaded ${result.fileCount} files`);
- * ```
- *
- * ## Search Bundled Docs
- *
- * Use {@link searchDocs} and {@link readDocByQuery} to search and read bundled documentation:
- *
- * ```typescript
- * import { searchDocs, readDocByQuery } from '@salesforce/b2c-tooling-sdk/docs';
- *
- * // Search for documentation
- * const results = searchDocs('ProductMgr');
- * results.forEach(r => console.log(r.entry.id, r.score));
- *
- * // Read a specific doc by fuzzy query
- * const doc = readDocByQuery('dw.catalog.ProductMgr');
- * if (doc) {
- *   console.log(doc.content);
- * }
- * ```
- *
- * @module docs
- */
-export type { DocEntry, SearchIndex, SearchResult, SchemaEntry, SchemaIndex, SchemaSearchResult } from './types.js';
-export { searchDocs, readDoc, readDocByQuery, listDocs, loadSearchIndex } from './search.js';
-export { listSchemas, readSchema, readSchemaByQuery, searchSchemas } from './schema.js';
-export { downloadDocs } from './download.js';
-export type { DownloadDocsOptions, DownloadDocsResult } from './download.js';

package/dist/cjs/docs/index.js

@@ -1,12 +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
- */
-// Search operations
-export { searchDocs, readDoc, readDocByQuery, listDocs, loadSearchIndex } from './search.js';
-// Schema operations
-export { listSchemas, readSchema, readSchemaByQuery, searchSchemas } from './schema.js';
-// Download operation
-export { downloadDocs } from './download.js';
-//# sourceMappingURL=index.js.map

package/dist/cjs/docs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA6CH,oBAAoB;AACpB,OAAO,EAAC,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,eAAe,EAAC,MAAM,aAAa,CAAC;AAE3F,oBAAoB;AACpB,OAAO,EAAC,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAEtF,qBAAqB;AACrB,OAAO,EAAC,YAAY,EAAC,MAAM,eAAe,CAAC"}

package/dist/cjs/docs/schema.d.ts

@@ -1,26 +0,0 @@
-import { type SchemaEntry, type SchemaSearchResult } from './types.js';
-/**
- * List all available schema entries.
- */
-export declare function listSchemas(): SchemaEntry[];
-/**
- * Read a schema by its exact ID.
- */
-export declare function readSchema(id: string): {
-    entry: SchemaEntry;
-    content: string;
-    path: string;
-} | null;
-/**
- * Find a schema by fuzzy query and return its content.
- * Returns the best match or null if no match found.
- */
-export declare function readSchemaByQuery(query: string): {
-    entry: SchemaEntry;
-    content: string;
-    path: string;
-} | null;
-/**
- * Search schemas by fuzzy query.
- */
-export declare function searchSchemas(query: string, limit?: number): SchemaSearchResult[];

package/dist/cjs/docs/schema.js

@@ -1,92 +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
- */
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import Fuse from 'fuse.js';
-import { XSD_DATA_DIR } from './types.js';
-// Lazy-loaded index and Fuse instance
-let schemaIndex = null;
-let fuseInstance = null;
-/**
- * Load the schema index from disk.
- */
-function loadIndex() {
-    if (schemaIndex) {
-        return schemaIndex;
-    }
-    const indexPath = path.join(XSD_DATA_DIR, 'index.json');
-    const content = fs.readFileSync(indexPath, 'utf-8');
-    schemaIndex = JSON.parse(content);
-    return schemaIndex;
-}
-/**
- * Get or create the Fuse.js search instance.
- */
-function getFuse() {
-    if (fuseInstance) {
-        return fuseInstance;
-    }
-    const index = loadIndex();
-    fuseInstance = new Fuse(index.entries, {
-        keys: [{ name: 'id', weight: 1 }],
-        includeScore: true,
-        threshold: 0.4,
-    });
-    return fuseInstance;
-}
-/**
- * List all available schema entries.
- */
-export function listSchemas() {
-    const index = loadIndex();
-    return index.entries;
-}
-/**
- * Read a schema by its exact ID.
- */
-export function readSchema(id) {
-    const index = loadIndex();
-    const entry = index.entries.find((e) => e.id === id);
-    if (!entry) {
-        return null;
-    }
-    const filePath = path.join(XSD_DATA_DIR, entry.filePath);
-    const content = fs.readFileSync(filePath, 'utf-8');
-    return { entry, content, path: filePath };
-}
-/**
- * Find a schema by fuzzy query and return its content.
- * Returns the best match or null if no match found.
- */
-export function readSchemaByQuery(query) {
-    // First try exact match
-    const exactMatch = readSchema(query);
-    if (exactMatch) {
-        return exactMatch;
-    }
-    // Try fuzzy search
-    const fuse = getFuse();
-    const results = fuse.search(query, { limit: 1 });
-    if (results.length === 0) {
-        return null;
-    }
-    const bestMatch = results[0];
-    const filePath = path.join(XSD_DATA_DIR, bestMatch.item.filePath);
-    const content = fs.readFileSync(filePath, 'utf-8');
-    return { entry: bestMatch.item, content, path: filePath };
-}
-/**
- * Search schemas by fuzzy query.
- */
-export function searchSchemas(query, limit = 20) {
-    const fuse = getFuse();
-    const results = fuse.search(query, { limit });
-    return results.map((result) => ({
-        entry: result.item,
-        score: result.score ?? 0,
-    }));
-}
-//# sourceMappingURL=schema.js.map

package/dist/cjs/docs/schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/docs/schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAC,YAAY,EAA8D,MAAM,YAAY,CAAC;AAErG,sCAAsC;AACtC,IAAI,WAAW,GAAuB,IAAI,CAAC;AAC3C,IAAI,YAAY,GAA6B,IAAI,CAAC;AAElD;;GAEG;AACH,SAAS,SAAS;IAChB,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACpD,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAgB,CAAC;IACjD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,OAAO;IACd,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,YAAY,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;QACrC,IAAI,EAAE,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAC,CAAC;QAC/B,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,GAAG;KACf,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,EAAU;IACnC,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAErD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEnD,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,wBAAwB;IACxB,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,mBAAmB;IACnB,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IACvB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC;IAE/C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEnD,OAAO,EAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAC,CAAC;AAC1D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa,EAAE,KAAK,GAAG,EAAE;IACrD,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IACvB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;IAE5C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC,IAAI;QAClB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;KACzB,CAAC,CAAC,CAAC;AACN,CAAC"}

package/dist/cjs/docs/search.d.ts

@@ -1,67 +0,0 @@
-import { type DocEntry, type SearchIndex, type SearchResult } from './types.js';
-/**
- * Loads the pre-built search index from the bundled data directory.
- *
- * @returns The search index with all documentation entries
- * @throws Error if the index file cannot be read
- */
-export declare function loadSearchIndex(): SearchIndex;
-/**
- * Searches the documentation index with fuzzy matching.
- *
- * @param query - The search query string
- * @param limit - Maximum number of results to return (default: 20)
- * @returns Array of search results sorted by relevance
- *
- * @example
- * ```typescript
- * const results = searchDocs('ProductMgr');
- * results.forEach(r => console.log(r.entry.id, r.score));
- * ```
- */
-export declare function searchDocs(query: string, limit?: number): SearchResult[];
-/**
- * Reads the content of a documentation file by its ID.
- *
- * @param id - The documentation ID (filename without .md extension)
- * @returns The raw markdown content of the document
- * @throws Error if the document is not found
- *
- * @example
- * ```typescript
- * const content = readDoc('dw.catalog.ProductMgr');
- * console.log(content);
- * ```
- */
-export declare function readDoc(id: string): string;
-/**
- * Reads documentation by fuzzy-matching the query and returning the best match.
- *
- * @param query - The search query string
- * @returns The best matching entry and its content, or null if no match
- *
- * @example
- * ```typescript
- * const doc = readDocByQuery('ProductMgr');
- * if (doc) {
- *   console.log(`Found: ${doc.entry.title}`);
- *   console.log(doc.content);
- * }
- * ```
- */
-export declare function readDocByQuery(query: string): {
-    entry: DocEntry;
-    content: string;
-} | null;
-/**
- * Lists all available documentation entries.
- *
- * @returns Array of all documentation entries in the index
- *
- * @example
- * ```typescript
- * const docs = listDocs();
- * console.log(`${docs.length} documentation files available`);
- * ```
- */
-export declare function listDocs(): DocEntry[];

package/dist/cjs/docs/search.js

@@ -1,128 +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
- */
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import Fuse from 'fuse.js';
-import { SCRIPT_API_DATA_DIR } from './types.js';
-// Singleton cache for loaded index and Fuse instance
-let cachedIndex = null;
-let cachedFuse = null;
-/**
- * Loads the pre-built search index from the bundled data directory.
- *
- * @returns The search index with all documentation entries
- * @throws Error if the index file cannot be read
- */
-export function loadSearchIndex() {
-    if (cachedIndex)
-        return cachedIndex;
-    const indexPath = path.join(SCRIPT_API_DATA_DIR, 'index.json');
-    const indexContent = fs.readFileSync(indexPath, 'utf-8');
-    cachedIndex = JSON.parse(indexContent);
-    return cachedIndex;
-}
-/**
- * Gets or creates the Fuse.js search instance.
- */
-function getFuseInstance() {
-    if (cachedFuse)
-        return cachedFuse;
-    const index = loadSearchIndex();
-    cachedFuse = new Fuse(index.entries, {
-        keys: [
-            { name: 'title', weight: 0.5 },
-            { name: 'id', weight: 0.5 },
-        ],
-        threshold: 0.4,
-        includeScore: true,
-        minMatchCharLength: 2,
-        ignoreLocation: true,
-    });
-    return cachedFuse;
-}
-/**
- * Searches the documentation index with fuzzy matching.
- *
- * @param query - The search query string
- * @param limit - Maximum number of results to return (default: 20)
- * @returns Array of search results sorted by relevance
- *
- * @example
- * ```typescript
- * const results = searchDocs('ProductMgr');
- * results.forEach(r => console.log(r.entry.id, r.score));
- * ```
- */
-export function searchDocs(query, limit = 20) {
-    const fuse = getFuseInstance();
-    const results = fuse.search(query, { limit });
-    return results.map((r) => ({
-        entry: r.item,
-        score: r.score ?? 0,
-    }));
-}
-/**
- * Reads the content of a documentation file by its ID.
- *
- * @param id - The documentation ID (filename without .md extension)
- * @returns The raw markdown content of the document
- * @throws Error if the document is not found
- *
- * @example
- * ```typescript
- * const content = readDoc('dw.catalog.ProductMgr');
- * console.log(content);
- * ```
- */
-export function readDoc(id) {
-    const index = loadSearchIndex();
-    const entry = index.entries.find((e) => e.id === id);
-    if (!entry) {
-        throw new Error(`Documentation not found: ${id}`);
-    }
-    const filePath = path.join(SCRIPT_API_DATA_DIR, entry.filePath);
-    return fs.readFileSync(filePath, 'utf-8');
-}
-/**
- * Reads documentation by fuzzy-matching the query and returning the best match.
- *
- * @param query - The search query string
- * @returns The best matching entry and its content, or null if no match
- *
- * @example
- * ```typescript
- * const doc = readDocByQuery('ProductMgr');
- * if (doc) {
- *   console.log(`Found: ${doc.entry.title}`);
- *   console.log(doc.content);
- * }
- * ```
- */
-export function readDocByQuery(query) {
-    const results = searchDocs(query, 1);
-    if (results.length === 0) {
-        return null;
-    }
-    const entry = results[0].entry;
-    const content = readDoc(entry.id);
-    return { entry, content };
-}
-/**
- * Lists all available documentation entries.
- *
- * @returns Array of all documentation entries in the index
- *
- * @example
- * ```typescript
- * const docs = listDocs();
- * console.log(`${docs.length} documentation files available`);
- * ```
- */
-export function listDocs() {
-    const index = loadSearchIndex();
-    return index.entries;
-}
-//# sourceMappingURL=search.js.map

package/dist/cjs/docs/search.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/docs/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAC,mBAAmB,EAAqD,MAAM,YAAY,CAAC;AAEnG,qDAAqD;AACrD,IAAI,WAAW,GAAuB,IAAI,CAAC;AAC3C,IAAI,UAAU,GAA0B,IAAI,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,UAAU,eAAe;IAC7B,IAAI,WAAW;QAAE,OAAO,WAAW,CAAC;IAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACzD,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAgB,CAAC;IACtD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,eAAe;IACtB,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC;IAElC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAEhC,UAAU,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;QACnC,IAAI,EAAE;YACJ,EAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAC;YAC5B,EAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAC;SAC1B;QACD,SAAS,EAAE,GAAG;QACd,YAAY,EAAE,IAAI;QAClB,kBAAkB,EAAE,CAAC;QACrB,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,KAAK,GAAG,EAAE;IAClD,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;IAE5C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,KAAK,EAAE,CAAC,CAAC,IAAI;QACb,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;KACpB,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO,CAAC,EAAU;IAChC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAErD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChE,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAErC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAElC,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC"}

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

@@ -1,64 +0,0 @@
-export declare const SCRIPT_API_DATA_DIR: string;
-export declare const XSD_DATA_DIR: string;
-/**
- * A documentation entry in the search index.
- */
-export interface DocEntry {
-    /** Unique identifier - the filename without .md extension (e.g., "dw.catalog.ProductMgr") */
-    id: string;
-    /** The title from the document heading (e.g., "Class ProductMgr") */
-    title: string;
-    /** The filename (e.g., "dw.catalog.ProductMgr.md") */
-    filePath: string;
-    /** Optional preview/excerpt from the document */
-    preview?: string;
-}
-/**
- * The search index structure stored in index.json.
- */
-export interface SearchIndex {
-    /** Version of the index format */
-    version: string;
-    /** Timestamp when the index was generated */
-    generatedAt: string;
-    /** Array of documentation entries */
-    entries: DocEntry[];
-}
-/**
- * A search result with relevance score.
- */
-export interface SearchResult {
-    /** The matching documentation entry */
-    entry: DocEntry;
-    /** Match score (lower is better in Fuse.js, 0 = perfect match) */
-    score: number;
-}
-/**
- * An XSD schema entry in the index.
- */
-export interface SchemaEntry {
-    /** Unique identifier - the filename without .xsd extension (e.g., "catalog") */
-    id: string;
-    /** The filename (e.g., "catalog.xsd") */
-    filePath: string;
-}
-/**
- * The schema index structure stored in index.json.
- */
-export interface SchemaIndex {
-    /** Version of the index format */
-    version: string;
-    /** Timestamp when the index was generated */
-    generatedAt: string;
-    /** Array of schema entries */
-    entries: SchemaEntry[];
-}
-/**
- * A schema search result with relevance score.
- */
-export interface SchemaSearchResult {
-    /** The matching schema entry */
-    entry: SchemaEntry;
-    /** Match score (lower is better in Fuse.js, 0 = perfect match) */
-    score: number;
-}

package/dist/cjs/docs/types.js

@@ -1,15 +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
- */
-import path from 'node:path';
-import { createRequire } from 'node:module';
-// Resolve the data directories from the package root
-// Uses createRequire to find the package.json location, which is robust
-// regardless of where this module is located in the build output
-const require = createRequire(import.meta.url);
-const packageRoot = path.dirname(require.resolve('@salesforce/b2c-tooling-sdk/package.json'));
-export const SCRIPT_API_DATA_DIR = path.join(packageRoot, 'data/script-api');
-export const XSD_DATA_DIR = path.join(packageRoot, 'data/xsd');
-//# sourceMappingURL=types.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/docs/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAE1C,qDAAqD;AACrD,wEAAwE;AACxE,iEAAiE;AACjE,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC,CAAC;AAE9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC"}

package/dist/cjs/errors/http-error.d.ts

@@ -1,34 +0,0 @@
-/**
- * Custom error class for HTTP errors from API clients.
- *
- * Wraps the Response object directly for full access to response details.
- *
- * @example
- * try {
- *   await webdav.delete('some/path');
- * } catch (error) {
- *   if (error instanceof HTTPError && error.response.status === 404) {
- *     // Handle not found
- *   }
- *   throw error;
- * }
- *
- * @module errors/http-error
- */
-/**
- * Error thrown when an HTTP request fails.
- *
- * Wraps the original Response for access to status, headers, and body.
- */
-export declare class HTTPError extends Error {
-    /**
-     * The original Response object from the failed request.
-     * Note: Body can only be read once via response.text(), response.json(), etc.
-     */
-    readonly response: Response;
-    /**
-     * HTTP method used for the request (GET, POST, PUT, DELETE, etc.).
-     */
-    readonly method: string;
-    constructor(message: string, response: Response, method: string);
-}