@salesforce/b2c-tooling-sdk 2.4.0 → 2.5.0

package/dist/esm/scapi/schema-source.d.ts

@@ -0,0 +1,90 @@
+import type { SchemaListItem } from '../clients/scapi-schemas.js';
+import { type ApiDocument, type ScapiSchemaDocument } from './catalog.js';
+/**
+ * Sections the Schemas API can add to a contract through its `expand` query parameter.
+ *
+ * Without `expand` a contract has no operation summaries or descriptions, no examples, and no tenant custom
+ * properties. `all` is a superset of every other value.
+ */
+export declare const SCAPI_SCHEMA_EXPANSIONS: readonly ["all", "custom_properties", "descriptions", "examples", "external_docs", "summaries", "tags", "titles"];
+export type ScapiSchemaExpansion = (typeof SCAPI_SCHEMA_EXPANSIONS)[number];
+/**
+ * Validate expansion names and join them the way the Schemas API expects: one `expand` value, separated by
+ * commas (semicolons are accepted when parsing). The API rejects a repeated `expand` parameter.
+ *
+ * @returns The canonical value, or undefined when nothing is requested.
+ * @throws When a name is not a known expansion.
+ */
+export declare function normalizeScapiSchemaExpand(input: string | readonly string[] | undefined): string | undefined;
+/**
+ * Every section except tenant custom properties. The distributable bundled corpus is built with this, so it
+ * carries the full prose and examples but nothing specific to one tenant.
+ */
+export declare const SCAPI_STANDARD_SCHEMA_EXPAND = "descriptions,examples,external_docs,summaries,tags,titles";
+/** Whether an `expand` value requests a section; `all` includes every section. */
+export declare function scapiExpandIncludes(expand: string | undefined, section: ScapiSchemaExpansion): boolean;
+/** Whether the contract carries tenant custom properties and operation prose, so it can serve code mode. */
+export declare function isFullScapiExpand(expand: string | undefined): boolean;
+/** What a caller will do with a contract; used to ask the server for only that much. */
+export interface ScapiSchemaNeeds {
+    /** The whole contract: every section (`all`). Overrides the other needs. */
+    full?: boolean;
+    /** Operation, parameter and schema prose (`summaries`, `descriptions`, `titles`). */
+    prose?: boolean;
+    /** Request and response examples. */
+    examples?: boolean;
+    /** Tenant custom properties (`c_*` attributes). */
+    customProperties?: boolean;
+}
+/**
+ * Smallest `expand` value that satisfies what the caller will use, so outline-only reads stay small.
+ *
+ * @returns The `expand` value, or undefined when no section is needed.
+ */
+export declare function scapiSchemaExpandFor(needs: ScapiSchemaNeeds): string | undefined;
+export interface ScapiSchemaIdentity {
+    apiFamily: string;
+    apiName: string;
+    apiVersion: string;
+}
+/** Find a standard contract in the bundled corpus. */
+export declare function findBundledScapiSchema(identity: ScapiSchemaIdentity): ScapiSchemaDocument | undefined;
+export interface ScapiSchemaFilter {
+    apiFamily?: string;
+    apiName?: string;
+    apiVersion?: string;
+    status?: string;
+}
+/** List the bundled corpus in the Schemas API listing shape, applying the same filters. */
+export declare function listBundledScapiSchemas(filter?: ScapiSchemaFilter): SchemaListItem[];
+/** Where a contract or listing came from. */
+export type ScapiSchemaSource = 'live' | 'bundled';
+export interface ScapiSchemaFetchResult {
+    schema: ApiDocument;
+    source: ScapiSchemaSource;
+    /** Set when `source` is `bundled` because the live fetch failed. */
+    warning?: string;
+}
+export interface ScapiSchemaListFetchResult {
+    schemas: SchemaListItem[];
+    total: number;
+    source: ScapiSchemaSource;
+    warning?: string;
+}
+/**
+ * Fetch one contract live, falling back to the bundled corpus when the live fetch fails (missing
+ * configuration or credentials, no access, network or server errors).
+ *
+ * The bundled contract always carries the full prose and examples, regardless of the requested expansion.
+ * Custom APIs exist only on the tenant, so their failure is rethrown. Abort errors are never swallowed.
+ *
+ * @param identity - API family, name and version
+ * @param fetchLive - Fetches the contract, building the client lazily so configuration errors fall back too
+ * @param signal - Abort signal; an aborted request throws instead of falling back
+ */
+export declare function fetchScapiSchemaWithFallback(identity: ScapiSchemaIdentity, fetchLive: () => Promise<ApiDocument>, signal?: AbortSignal): Promise<ScapiSchemaFetchResult>;
+/** List schemas live, falling back to the bundled corpus (with the same filters) when the live listing fails. */
+export declare function listScapiSchemasWithFallback(filter: ScapiSchemaFilter, fetchLive: () => Promise<{
+    schemas: SchemaListItem[];
+    total: number;
+}>, signal?: AbortSignal): Promise<ScapiSchemaListFetchResult>;

package/dist/esm/scapi/schema-source.js

@@ -0,0 +1,146 @@
+/*
+ * 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 { loadScapiSchemas } from './catalog.js';
+/**
+ * Sections the Schemas API can add to a contract through its `expand` query parameter.
+ *
+ * Without `expand` a contract has no operation summaries or descriptions, no examples, and no tenant custom
+ * properties. `all` is a superset of every other value.
+ */
+export const SCAPI_SCHEMA_EXPANSIONS = [
+    'all',
+    'custom_properties',
+    'descriptions',
+    'examples',
+    'external_docs',
+    'summaries',
+    'tags',
+    'titles',
+];
+/**
+ * Validate expansion names and join them the way the Schemas API expects: one `expand` value, separated by
+ * commas (semicolons are accepted when parsing). The API rejects a repeated `expand` parameter.
+ *
+ * @returns The canonical value, or undefined when nothing is requested.
+ * @throws When a name is not a known expansion.
+ */
+export function normalizeScapiSchemaExpand(input) {
+    const names = (Array.isArray(input) ? input : [input ?? ''])
+        .flatMap((value) => String(value).split(/[,;]/))
+        .map((value) => value.trim())
+        .filter(Boolean);
+    const unknown = names.filter((name) => !SCAPI_SCHEMA_EXPANSIONS.includes(name));
+    if (unknown.length > 0)
+        throw new Error(`Unknown schema expansion ${unknown.map((name) => `"${name}"`).join(', ')}. Valid values: ${SCAPI_SCHEMA_EXPANSIONS.join(', ')}.`);
+    if (names.includes('all'))
+        return 'all';
+    const unique = SCAPI_SCHEMA_EXPANSIONS.filter((name) => names.includes(name));
+    return unique.length > 0 ? unique.join(',') : undefined;
+}
+/**
+ * Every section except tenant custom properties. The distributable bundled corpus is built with this, so it
+ * carries the full prose and examples but nothing specific to one tenant.
+ */
+export const SCAPI_STANDARD_SCHEMA_EXPAND = 'descriptions,examples,external_docs,summaries,tags,titles';
+/** Whether an `expand` value requests a section; `all` includes every section. */
+export function scapiExpandIncludes(expand, section) {
+    const names = (expand ?? '').split(/[,;]/).map((value) => value.trim());
+    return names.includes('all') || names.includes(section);
+}
+/** Whether the contract carries tenant custom properties and operation prose, so it can serve code mode. */
+export function isFullScapiExpand(expand) {
+    return (scapiExpandIncludes(expand, 'custom_properties') &&
+        scapiExpandIncludes(expand, 'summaries') &&
+        scapiExpandIncludes(expand, 'descriptions'));
+}
+/**
+ * Smallest `expand` value that satisfies what the caller will use, so outline-only reads stay small.
+ *
+ * @returns The `expand` value, or undefined when no section is needed.
+ */
+export function scapiSchemaExpandFor(needs) {
+    if (needs.full)
+        return 'all';
+    const names = [];
+    if (needs.customProperties)
+        names.push('custom_properties');
+    if (needs.prose)
+        names.push('summaries', 'descriptions', 'titles');
+    if (needs.examples)
+        names.push('examples');
+    return normalizeScapiSchemaExpand(names);
+}
+/** Find a standard contract in the bundled corpus. */
+export function findBundledScapiSchema(identity) {
+    const id = `${identity.apiFamily}/${identity.apiName}/${identity.apiVersion}`;
+    return loadScapiSchemas().find((document) => document.entry.id === id);
+}
+/** List the bundled corpus in the Schemas API listing shape, applying the same filters. */
+export function listBundledScapiSchemas(filter = {}) {
+    return loadScapiSchemas()
+        .filter(({ entry }) => (!filter.apiFamily || entry.apiFamily === filter.apiFamily) &&
+        (!filter.apiName || entry.apiName === filter.apiName) &&
+        (!filter.apiVersion || entry.apiVersion === filter.apiVersion) &&
+        (!filter.status || entry.status === filter.status))
+        .map(({ entry }) => ({
+        schemaVersion: entry.schemaVersion,
+        apiFamily: entry.apiFamily,
+        apiName: entry.apiName,
+        apiVersion: entry.apiVersion,
+        status: entry.status,
+    }));
+}
+function reason(error) {
+    return (error instanceof Error ? error.message : String(error)).replaceAll(/\s+/g, ' ').trim().slice(0, 300);
+}
+const BUNDLED_LIMITS = 'The bundled corpus has the standard SCAPI contracts only: no tenant custom properties or custom APIs, and it may be older than your tenant.';
+/**
+ * Fetch one contract live, falling back to the bundled corpus when the live fetch fails (missing
+ * configuration or credentials, no access, network or server errors).
+ *
+ * The bundled contract always carries the full prose and examples, regardless of the requested expansion.
+ * Custom APIs exist only on the tenant, so their failure is rethrown. Abort errors are never swallowed.
+ *
+ * @param identity - API family, name and version
+ * @param fetchLive - Fetches the contract, building the client lazily so configuration errors fall back too
+ * @param signal - Abort signal; an aborted request throws instead of falling back
+ */
+export async function fetchScapiSchemaWithFallback(identity, fetchLive, signal) {
+    try {
+        return { schema: await fetchLive(), source: 'live' };
+    }
+    catch (error) {
+        if (signal?.aborted)
+            throw error;
+        const bundled = findBundledScapiSchema(identity);
+        if (!bundled)
+            throw error;
+        return {
+            schema: bundled.schema,
+            source: 'bundled',
+            warning: `Live schema unavailable (${reason(error)}). Showing the bundled ${bundled.entry.id} contract ` +
+                `(schema ${bundled.entry.schemaVersion}). ${BUNDLED_LIMITS}`,
+        };
+    }
+}
+/** List schemas live, falling back to the bundled corpus (with the same filters) when the live listing fails. */
+export async function listScapiSchemasWithFallback(filter, fetchLive, signal) {
+    try {
+        return { ...(await fetchLive()), source: 'live' };
+    }
+    catch (error) {
+        if (signal?.aborted)
+            throw error;
+        const schemas = listBundledScapiSchemas(filter);
+        return {
+            schemas,
+            total: schemas.length,
+            source: 'bundled',
+            warning: `Live schema listing unavailable (${reason(error)}). Listing the bundled corpus. ${BUNDLED_LIMITS}`,
+        };
+    }
+}
+//# sourceMappingURL=schema-source.js.map

package/dist/esm/scapi/schema-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-source.js","sourceRoot":"","sources":["../../../src/scapi/schema-source.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,gBAAgB,EAA6C,MAAM,cAAc,CAAC;AAE1F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,KAAK;IACL,mBAAmB;IACnB,cAAc;IACd,UAAU;IACV,eAAe;IACf,WAAW;IACX,MAAM;IACN,QAAQ;CACA,CAAC;AAIX;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAA6C;IACtF,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;SACzD,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SAC/C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC5B,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAE,uBAA6C,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACvG,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAClI,CAAC;IACJ,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACxC,MAAM,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,2DAA2D,CAAC;AAExG,kFAAkF;AAClF,MAAM,UAAU,mBAAmB,CAAC,MAA0B,EAAE,OAA6B;IAC3F,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC1D,CAAC;AAED,4GAA4G;AAC5G,MAAM,UAAU,iBAAiB,CAAC,MAA0B;IAC1D,OAAO,CACL,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,CAAC;QAChD,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC;QACxC,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAC5C,CAAC;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAuB;IAC1D,IAAI,KAAK,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAC7B,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,KAAK,CAAC,gBAAgB;QAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC5D,IAAI,KAAK,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;IACnE,IAAI,KAAK,CAAC,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3C,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAQD,sDAAsD;AACtD,MAAM,UAAU,sBAAsB,CAAC,QAA6B;IAClE,MAAM,EAAE,GAAG,GAAG,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC9E,OAAO,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AACzE,CAAC;AASD,2FAA2F;AAC3F,MAAM,UAAU,uBAAuB,CAAC,SAA4B,EAAE;IACpE,OAAO,gBAAgB,EAAE;SACtB,MAAM,CACL,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CACV,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC;QAC3D,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC;QACrD,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,CAAC;QAC9D,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CACrD;SACA,GAAG,CAAC,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC;QACjB,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,MAAM,EAAE,KAAK,CAAC,MAAkC;KACjD,CAAC,CAAC,CAAC;AACR,CAAC;AAmBD,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/G,CAAC;AAED,MAAM,cAAc,GAClB,6IAA6I,CAAC;AAEhJ;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,QAA6B,EAC7B,SAAqC,EACrC,MAAoB;IAEpB,IAAI,CAAC;QACH,OAAO,EAAC,MAAM,EAAE,MAAM,SAAS,EAAE,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,MAAM,EAAE,OAAO;YAAE,MAAM,KAAK,CAAC;QACjC,MAAM,OAAO,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO;YAAE,MAAM,KAAK,CAAC;QAC1B,OAAO;YACL,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,SAAS;YACjB,OAAO,EACL,4BAA4B,MAAM,CAAC,KAAK,CAAC,0BAA0B,OAAO,CAAC,KAAK,CAAC,EAAE,YAAY;gBAC/F,WAAW,OAAO,CAAC,KAAK,CAAC,aAAa,MAAM,cAAc,EAAE;SAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,iHAAiH;AACjH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,MAAyB,EACzB,SAAoE,EACpE,MAAoB;IAEpB,IAAI,CAAC;QACH,OAAO,EAAC,GAAG,CAAC,MAAM,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,MAAM,EAAE,OAAO;YAAE,MAAM,KAAK,CAAC;QACjC,MAAM,OAAO,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO;YACL,OAAO;YACP,KAAK,EAAE,OAAO,CAAC,MAAM;YACrB,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,oCAAoC,MAAM,CAAC,KAAK,CAAC,kCAAkC,cAAc,EAAE;SAC7G,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/esm/scapi/worker-source.js

@@ -41,16 +41,40 @@ process.on('message', async message => {
     }
     return Object.fromEntries(Object.entries(value).map(([key, v]) => [key, resolve(v, api, seen, depth + 1)]));
   }
-  const spec = {apis: documents.map(d => d.entry), paths: {}, resolve};
+  // Keys of these objects are names chosen by the API, not schema keywords, so a property called description survives.
+  const NAME_MAPS = new Set(['properties', 'patternProperties', 'headers', 'content', 'responses', 'schemas', 'scopes', 'links', 'callbacks', 'securitySchemes']);
+  const VALUE_KEYS = new Set(['default', 'enum', 'const']);
+  function outline(value, nameMap = false) {
+    if (!value || typeof value !== 'object') return value;
+    if (Array.isArray(value)) return value.map(v => outline(v));
+    const out = {};
+    for (const [key, v] of Object.entries(value)) {
+      if (!nameMap && (key === 'description' || key === 'example' || key === 'examples')) continue;
+      out[key] = !nameMap && VALUE_KEYS.has(key) ? v : outline(v, !nameMap && NAME_MAPS.has(key));
+    }
+    return out;
+  }
+  const outlined = message.detail === 'outline';
+  const resolveDetail = (value, api) => outlined ? outline(resolve(value, api)) : resolve(value, api);
+  const specData = {apis: documents.map(d => d.entry), paths: {}, resolve: resolveDetail};
+  const spec = new Proxy(specData, {get(target, key, receiver) {
+    if (typeof key === 'symbol' || key in target || key === 'then' || key === 'toJSON') return Reflect.get(target, key, receiver);
+    throw new Error('SCAPI_SPEC_UNKNOWN_MEMBER: spec.' + key + ' does not exist. spec has only apis (array of API entries), paths ({[fullPath]: {[method]: operation}}) and resolve(value, apiId). List operations with Object.entries(spec.paths).');
+  }});
   for (const {entry, schema} of documents) {
     for (const [path, item] of Object.entries(schema.paths || {})) {
       const methods = {};
       for (const method of ['get','head','post','put','patch','delete','options']) {
-        if (item[method]) methods[method] = resolve({...item[method], api: entry.id,
-          parameters: [...(item.parameters || []), ...(item[method].parameters || [])],
-          security: item[method].security ?? schema.security ?? []}, entry.id);
+        if (item[method]) {
+          const operation = {...item[method], api: entry.id,
+            parameters: [...(item.parameters || []), ...(item[method].parameters || [])],
+            security: item[method].security ?? schema.security ?? []};
+          // Keep the operation's own prose; only what it references is trimmed.
+          const {summary, description, ...rest} = operation;
+          methods[method] = {...(summary === undefined ? {} : {summary}), ...(description === undefined ? {} : {description}), ...resolveDetail(rest, entry.id)};
+        }
       }
-      spec.paths['/' + entry.id + (entry.apiFamily === 'custom' ? '/organizations/{organizationId}' : '') + path] = methods;
+      specData.paths['/' + entry.id + (entry.apiFamily === 'custom' ? '/organizations/{organizationId}' : '') + path] = methods;
     }
   }
   const scapi = {request: options => new Promise((resolve, reject) => {
@@ -88,7 +112,7 @@ process.on('message', async message => {
     const value = await evaluate(message.code, message.input);
     if (pending.size || runningSnippets) throw new Error('Await every scapi.request, auth, and codemode call before returning. Requests may already have taken effect.');
     const json = JSON.stringify(value === undefined ? null : value);
-    if (Buffer.byteLength(json) > message.maxOutputBytes) throw new Error('SCAPI_RESULT_TOO_LARGE: return fewer fields or a smaller page.');
+    if (Buffer.byteLength(json) > message.maxOutputBytes) throw new Error('SCAPI_RESULT_TOO_LARGE: return fewer fields or a smaller page. Whole operations include every parameter and schema description; return operationId, method, path and summary to list candidates, and only the parts you need (parameters, requestBody) for one.');
     send({type:'result', value: JSON.parse(json)});
   } catch (error) {
     const message = error.code === 'ERR_ACCESS_DENIED'

package/dist/esm/scapi/worker-source.js.map

@@ -1 +1 @@
-{"version":3,"file":"worker-source.js","sourceRoot":"","sources":["../../../src/scapi/worker-source.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qGAAqG;AACrG,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6F5C,CAAC"}
+{"version":3,"file":"worker-source.js","sourceRoot":"","sources":["../../../src/scapi/worker-source.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qGAAqG;AACrG,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqH5C,CAAC"}

package/dist/esm/test-utils/config-isolation.js

@@ -3,8 +3,11 @@
  * 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 { mkdtempSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
 import { resetLogger } from '../logging/index.js';
-const ADDITIONAL_ENV_VARS = ['COMMERCE_API_SLAS_SECRET', 'LANGUAGE', 'NO_COLOR'];
+const ADDITIONAL_ENV_VARS = ['B2C_CONFIG_DIR', 'COMMERCE_API_SLAS_SECRET', 'LANGUAGE', 'NO_COLOR'];
 function isIsolatedEnvVar(key) {
     return (key.startsWith('SFCC_') || key.startsWith('MRT_') || key.startsWith('PUBLIC__') || ADDITIONAL_ENV_VARS.includes(key));
 }
@@ -24,9 +27,12 @@ export function isolateConfig() {
     process.env.SFCC_DOTENV_FILE = '';
     process.env.MRT_CREDENTIALS_FILE = '/dev/null';
     process.env.SFCC_LOG_LEVEL = 'silent';
+    // An empty settings directory, so the user's global default dw.json is never read or written
+    const configDirectory = mkdtempSync(path.join(tmpdir(), 'b2c-test-config-'));
+    process.env.B2C_CONFIG_DIR = configDirectory;
     // Reset global logger so it picks up the new SFCC_LOG_LEVEL
     resetLogger();
-    state = { savedEnvVars };
+    state = { configDirectory, savedEnvVars };
 }
 export function restoreConfig() {
     if (!state)
@@ -42,6 +48,7 @@ export function restoreConfig() {
         if (value !== undefined)
             process.env[key] = value;
     }
+    rmSync(state.configDirectory, { recursive: true, force: true });
     state = null;
 }
 //# sourceMappingURL=config-isolation.js.map

package/dist/esm/test-utils/config-isolation.js.map

@@ -1 +1 @@
-{"version":3,"file":"config-isolation.js","sourceRoot":"","sources":["../../../src/test-utils/config-isolation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAEhD,MAAM,mBAAmB,GAAG,CAAC,0BAA0B,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAEjF,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,CACL,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CACrH,CAAC;AACJ,CAAC;AAMD,IAAI,KAAK,GAA0B,IAAI,CAAC;AAExC,MAAM,UAAU,aAAa;IAC3B,IAAI,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IAElG,MAAM,YAAY,GAAuC,EAAE,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;IACtC,qCAAqC;IACrC,OAAO,CAAC,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC;IAClC,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,WAAW,CAAC;IAC/C,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC;IAEtC,4DAA4D;IAC5D,WAAW,EAAE,CAAC;IAEd,KAAK,GAAG,EAAC,YAAY,EAAC,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,IAAI,CAAC,KAAK;QAAE,OAAO;IAEnB,yCAAyC;IACzC,WAAW,EAAE,CAAC;IAEd,8EAA8E;IAC9E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,GAAG,CAAC;YAAE,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACpD,CAAC;IAED,KAAK,GAAG,IAAI,CAAC;AACf,CAAC"}
+{"version":3,"file":"config-isolation.js","sourceRoot":"","sources":["../../../src/test-utils/config-isolation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,WAAW,EAAE,MAAM,EAAC,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAC,MAAM,EAAC,MAAM,SAAS,CAAC;AAC/B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAEhD,MAAM,mBAAmB,GAAG,CAAC,gBAAgB,EAAE,0BAA0B,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAEnG,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,CACL,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CACrH,CAAC;AACJ,CAAC;AAOD,IAAI,KAAK,GAA0B,IAAI,CAAC;AAExC,MAAM,UAAU,aAAa;IAC3B,IAAI,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IAElG,MAAM,YAAY,GAAuC,EAAE,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;IACtC,qCAAqC;IACrC,OAAO,CAAC,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC;IAClC,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,WAAW,CAAC;IAC/C,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC;IACtC,6FAA6F;IAC7F,MAAM,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,eAAe,CAAC;IAE7C,4DAA4D;IAC5D,WAAW,EAAE,CAAC;IAEd,KAAK,GAAG,EAAC,eAAe,EAAE,YAAY,EAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,IAAI,CAAC,KAAK;QAAE,OAAO;IAEnB,yCAAyC;IACzC,WAAW,EAAE,CAAC;IAEd,8EAA8E;IAC9E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,GAAG,CAAC;YAAE,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACpD,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,EAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;IAE9D,KAAK,GAAG,IAAI,CAAC;AACf,CAAC"}