@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/operations/content/validate.js

@@ -1,170 +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 fs from 'node:fs';
-import path from 'node:path';
-import { createRequire } from 'node:module';
-import { Validator } from 'jsonschema';
-// Resolve the content-schemas data directory from the package root
-const require = createRequire(import.meta.url);
-const packageRoot = path.dirname(require.resolve('@salesforce/b2c-tooling-sdk/package.json'));
-export const CONTENT_SCHEMAS_DIR = path.join(packageRoot, 'data/content-schemas');
-/** Top-level schema types that users validate files against. */
-export const CONTENT_SCHEMA_TYPES = [
-    'pagetype',
-    'componenttype',
-    'aspecttype',
-    'cmsrecord',
-    'customeditortype',
-    'contentassetpageconfig',
-    'contentassetcomponentconfig',
-    'contentassetstructuredcontentdata',
-    'image',
-];
-/**
- * Error thrown when the schema type cannot be determined from the file path or data.
- */
-export class MetaDefinitionDetectionError extends Error {
-    constructor(message) {
-        super(message ??
-            `Unable to detect meta definition type. Use --type to specify one of: ${CONTENT_SCHEMA_TYPES.join(', ')}`);
-        this.name = 'MetaDefinitionDetectionError';
-    }
-}
-// Lazy-loaded validator singleton
-let validatorInstance = null;
-function getValidator() {
-    if (validatorInstance)
-        return validatorInstance;
-    validatorInstance = new Validator();
-    // Load all schemas so $ref resolution works across files
-    for (const file of fs.readdirSync(CONTENT_SCHEMAS_DIR)) {
-        if (file.endsWith('.json')) {
-            const schemaPath = path.join(CONTENT_SCHEMAS_DIR, file);
-            const schema = JSON.parse(fs.readFileSync(schemaPath, 'utf-8'));
-            // Register with /<filename> URI so relative $ref like "common.json#/definitions/name" resolves
-            // (jsonschema resolves relative refs against the parent schema's URI)
-            validatorInstance.addSchema(schema, `/${file}`);
-        }
-    }
-    return validatorInstance;
-}
-/**
- * Detect the metadefinition schema type from a file path using Page Designer conventions.
- *
- * - `experience/pages/` → `pagetype`
- * - `experience/components/` → `componenttype`
- */
-export function detectTypeFromPath(filePath) {
-    const normalized = filePath.replace(/\\/g, '/');
-    if (/experience\/pages\//.test(normalized))
-        return 'pagetype';
-    if (/experience\/components\//.test(normalized))
-        return 'componenttype';
-    return null;
-}
-/**
- * Detect the metadefinition schema type from the data's top-level properties.
- */
-export function detectTypeFromData(data) {
-    const keys = new Set(Object.keys(data));
-    if (keys.has('region_definitions')) {
-        return keys.has('group') ? 'componenttype' : 'pagetype';
-    }
-    if (keys.has('supported_object_types'))
-        return 'aspecttype';
-    if (keys.has('path'))
-        return 'image';
-    if (keys.has('resources'))
-        return 'customeditortype';
-    if (keys.has('data_binding'))
-        return 'contentassetcomponentconfig';
-    if (keys.has('visibility') && !keys.has('data_binding'))
-        return 'contentassetpageconfig';
-    if (keys.has('attributes') && keys.has('type'))
-        return 'cmsrecord';
-    return null;
-}
-/**
- * Detect the metadefinition schema type using a 3-tier strategy:
- * 1. File path convention (if filePath provided)
- * 2. Property heuristics from data
- * 3. Returns null if neither works (caller should use explicit --type or throw)
- */
-export function detectMetaDefinitionType(data, filePath) {
-    if (filePath) {
-        const fromPath = detectTypeFromPath(filePath);
-        if (fromPath)
-            return fromPath;
-    }
-    return detectTypeFromData(data);
-}
-function mapErrors(result) {
-    return result.errors.map((err) => ({
-        path: err.property.replace(/^instance/, '') || '/',
-        message: err.message,
-        property: err.property,
-    }));
-}
-/**
- * Validate a parsed JSON object against a content metadefinition schema.
- *
- * @throws {MetaDefinitionDetectionError} When the schema type cannot be detected and no explicit type is provided.
- */
-export function validateMetaDefinition(data, options) {
-    const schemaType = options?.type ?? detectMetaDefinitionType(data);
-    if (!schemaType) {
-        throw new MetaDefinitionDetectionError();
-    }
-    const validator = getValidator();
-    const result = validator.validate(data, { $ref: `/${schemaType}.json` });
-    return {
-        valid: result.valid,
-        schemaType,
-        errors: mapErrors(result),
-    };
-}
-/**
- * Validate a JSON metadefinition file against a content schema.
- *
- * Uses file path conventions for type detection before falling back to property heuristics.
- *
- * @throws {MetaDefinitionDetectionError} When the schema type cannot be detected and no explicit type is provided.
- */
-export function validateMetaDefinitionFile(filePath, options) {
-    const absolutePath = path.resolve(filePath);
-    const content = fs.readFileSync(absolutePath, 'utf-8');
-    let data;
-    try {
-        data = JSON.parse(content);
-    }
-    catch (err) {
-        return {
-            valid: false,
-            schemaType: options?.type ?? 'unknown',
-            errors: [
-                {
-                    path: '/',
-                    message: `Invalid JSON: ${err.message}`,
-                    property: 'instance',
-                },
-            ],
-            filePath: absolutePath,
-        };
-    }
-    const schemaType = options?.type ?? detectMetaDefinitionType(data, absolutePath);
-    if (!schemaType) {
-        throw new MetaDefinitionDetectionError();
-    }
-    const validator = getValidator();
-    const result = validator.validate(data, { $ref: `${schemaType}.json` });
-    return {
-        valid: result.valid,
-        schemaType,
-        errors: mapErrors(result),
-        filePath: absolutePath,
-    };
-}
-//# sourceMappingURL=validate.js.map

package/dist/cjs/operations/content/validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../src/operations/content/validate.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAC,SAAS,EAAoC,MAAM,YAAY,CAAC;AAExE,mEAAmE;AACnE,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;AAC9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAElF,gEAAgE;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,UAAU;IACV,eAAe;IACf,YAAY;IACZ,WAAW;IACX,kBAAkB;IAClB,wBAAwB;IACxB,6BAA6B;IAC7B,mCAAmC;IACnC,OAAO;CACC,CAAC;AA6BX;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD,YAAY,OAAgB;QAC1B,KAAK,CACH,OAAO;YACL,wEAAwE,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5G,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AAED,kCAAkC;AAClC,IAAI,iBAAiB,GAAqB,IAAI,CAAC;AAE/C,SAAS,YAAY;IACnB,IAAI,iBAAiB;QAAE,OAAO,iBAAiB,CAAC;IAEhD,iBAAiB,GAAG,IAAI,SAAS,EAAE,CAAC;IAEpC,yDAAyD;IACzD,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACvD,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAW,CAAC;YAC1E,+FAA+F;YAC/F,sEAAsE;YACtE,iBAAiB,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChD,IAAI,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC;QAAE,OAAO,UAAU,CAAC;IAC9D,IAAI,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;QAAE,OAAO,eAAe,CAAC;IACxE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAA6B;IAC9D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExC,IAAI,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC;IAC1D,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC;QAAE,OAAO,YAAY,CAAC;IAC5D,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO,OAAO,CAAC;IACrC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC;QAAE,OAAO,kBAAkB,CAAC;IACrD,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC;QAAE,OAAO,6BAA6B,CAAC;IACnE,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC;QAAE,OAAO,wBAAwB,CAAC;IACzF,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO,WAAW,CAAC;IACnE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAA6B,EAAE,QAAiB;IACvF,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;IAChC,CAAC;IACD,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,SAAS,CAAC,MAAuB;IACxC,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACjC,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,GAAG;QAClD,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,QAAQ,EAAE,GAAG,CAAC,QAAQ;KACvB,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAA6B,EAC7B,OAAuC;IAEvC,MAAM,UAAU,GAAG,OAAO,EAAE,IAAI,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEnE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,4BAA4B,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IACjC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,IAAI,EAAE,IAAI,UAAU,OAAO,EAAC,CAAC,CAAC;IAEvE,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU;QACV,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAAgB,EAChB,OAAuC;IAEvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAEvD,IAAI,IAA6B,CAAC;IAClC,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAC;IACxD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,UAAU,EAAE,OAAO,EAAE,IAAI,IAAK,SAA+B;YAC7D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,GAAG;oBACT,OAAO,EAAE,iBAAkB,GAAa,CAAC,OAAO,EAAE;oBAClD,QAAQ,EAAE,UAAU;iBACrB;aACF;YACD,QAAQ,EAAE,YAAY;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,EAAE,IAAI,IAAI,wBAAwB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAEjF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,4BAA4B,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IACjC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,IAAI,EAAE,GAAG,UAAU,OAAO,EAAC,CAAC,CAAC;IAEtE,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU;QACV,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;QACzB,QAAQ,EAAE,YAAY;KACvB,CAAC;AACJ,CAAC"}

package/dist/cjs/operations/debug/dap-adapter.d.ts

@@ -1,72 +0,0 @@
-/**
- * DAP (Debug Adapter Protocol) adapter for B2C Commerce Script Debugger.
- *
- * Extends `@vscode/debugadapter`'s LoggingDebugSession and maps DAP requests
- * to SDAPI operations. Works over stdio (CLI) or inline (VSCode extension).
- *
- * @module operations/debug/dap-adapter
- */
-import { LoggingDebugSession } from '@vscode/debugadapter';
-import type { DebugProtocol } from '@vscode/debugprotocol';
-import type { DebugSessionCallbacks, DebugSessionConfig } from './types.js';
-/**
- * Launch request arguments (received via launch.json or CLI config).
- */
-interface LaunchRequestArguments extends DebugProtocol.LaunchRequestArguments {
-    hostname?: string;
-    username?: string;
-    password?: string;
-    clientId?: string;
-    cartridgePath?: string;
-    pollInterval?: number;
-    keepaliveInterval?: number;
-}
-/**
- * B2C Script Debug Adapter.
- *
- * Can be used in two modes:
- * 1. **Pre-configured**: Pass a `DebugSessionConfig` to the constructor (for inline VSCode use)
- * 2. **Launch-configured**: Config comes from DAP launch request arguments (for CLI stdio use)
- */
-export declare class B2CScriptDebugAdapter extends LoggingDebugSession {
-    private session?;
-    private sourceMapper?;
-    private variableStore;
-    private preConfig?;
-    private externalCallbacks;
-    /** Breakpoints keyed by server script_path (merged across all files) */
-    private breakpointsBySource;
-    /** Logpoint messages keyed by "script_path:line_number" */
-    private logpoints;
-    constructor(config?: DebugSessionConfig, callbacks?: DebugSessionCallbacks);
-    /**
-     * Override shutdown to prevent the base class from calling process.exit().
-     * Process lifecycle is managed by the CLI command, not the adapter.
-     */
-    shutdown(): void;
-    protected initializeRequest(response: DebugProtocol.InitializeResponse, _args: DebugProtocol.InitializeRequestArguments): void;
-    protected launchRequest(response: DebugProtocol.LaunchResponse, args: LaunchRequestArguments): Promise<void>;
-    protected configurationDoneRequest(response: DebugProtocol.ConfigurationDoneResponse, _args: DebugProtocol.ConfigurationDoneArguments): void;
-    protected disconnectRequest(response: DebugProtocol.DisconnectResponse, _args: DebugProtocol.DisconnectArguments): Promise<void>;
-    protected terminateRequest(response: DebugProtocol.TerminateResponse, _args: DebugProtocol.TerminateArguments): Promise<void>;
-    protected setBreakPointsRequest(response: DebugProtocol.SetBreakpointsResponse, args: DebugProtocol.SetBreakpointsArguments): Promise<void>;
-    protected threadsRequest(response: DebugProtocol.ThreadsResponse): void;
-    protected stackTraceRequest(response: DebugProtocol.StackTraceResponse, args: DebugProtocol.StackTraceArguments): Promise<void>;
-    protected scopesRequest(response: DebugProtocol.ScopesResponse, args: DebugProtocol.ScopesArguments): void;
-    protected variablesRequest(response: DebugProtocol.VariablesResponse, args: DebugProtocol.VariablesArguments): Promise<void>;
-    protected evaluateRequest(response: DebugProtocol.EvaluateResponse, args: DebugProtocol.EvaluateArguments): Promise<void>;
-    protected continueRequest(response: DebugProtocol.ContinueResponse, args: DebugProtocol.ContinueArguments): Promise<void>;
-    protected nextRequest(response: DebugProtocol.NextResponse, args: DebugProtocol.NextArguments): Promise<void>;
-    protected stepInRequest(response: DebugProtocol.StepInResponse, args: DebugProtocol.StepInArguments): Promise<void>;
-    protected stepOutRequest(response: DebugProtocol.StepOutResponse, args: DebugProtocol.StepOutArguments): Promise<void>;
-    private handleThreadStopped;
-    private handleLogpoint;
-    private handleThreadContinued;
-    private handleThreadExited;
-    private resolveConfig;
-    private memberToVariable;
-    private friendlyErrorMessage;
-    private _nextBreakpointId;
-    private allocateBreakpointId;
-}
-export {};