@salesforce/storefront-next-dev 0.4.1 → 1.0.0-alpha.0

package/dist/index.d.ts

@@ -1,7 +1,5 @@
 import { Project } from "ts-morph";
-import { Express } from "express";
-import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
-import { ServerBuild } from "react-router";
+import { Plugin, ResolvedConfig } from "vite";
 
 //#region src/plugins/staticRegistry.d.ts
 
@@ -202,8 +200,8 @@ interface HybridProxyPluginOptions {
    * hybridProxyPlugin({ routeMatcher: shouldRouteToNext, ... })
    */
   routeMatcher: (pathname: string, routingRules: string) => boolean;
-  /** SFCC Site ID (e.g., 'RefArchGlobal') */
-  siteId: string;
+  /** SFCC default site ID (e.g., 'RefArchGlobal'). Required when `enabled` is true. */
+  defaultSiteId?: string;
   /** Locale for SFRA paths (e.g., 'en-GB'). Defaults to 'default' if not provided. */
   locale?: string;
 }
@@ -223,60 +221,7 @@ interface HybridProxyPluginOptions {
 declare function hybridProxyPlugin(options: HybridProxyPluginOptions): Plugin;
 //#endregion
 //#region src/plugins/ecdnMatcher.d.ts
-/**
- * Copyright 2026 Salesforce, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Extracts regex patterns from a Cloudflare routing expression.
- *
- * Parses Cloudflare "matches" expressions like:
- *   (http.request.uri.path matches "^/$" or http.request.uri.path matches "^/category.*")
- *
- * And extracts the regex patterns: ["^/$", "^/category.*"]
- *
- * @param expression - Cloudflare expression string
- * @returns Array of regex pattern strings
- *
- * @example
- * ```typescript
- * extractPatterns('(http.request.uri.path matches "^/$")');
- * // Returns: ["^/$"]
- *
- * extractPatterns('(http.request.uri.path matches "^/$" or http.request.uri.path matches "^/search.*")');
- * // Returns: ["^/$", "^/search.*"]
- * ```
- */
-declare function extractPatterns(expression: string): string[];
-/**
- * Tests if a pathname matches any of the provided regex patterns (logical OR).
- * Uses caching to optimize repeated pattern compilations.
- *
- * @param pathname - URL pathname to test (e.g., "/search", "/category/shoes")
- * @param patterns - Array of regex pattern strings
- * @returns true if pathname matches any pattern, false otherwise
- *
- * @example
- * ```typescript
- * testPatterns('/category/shoes', ['^/category.*', '^/search.*']);
- * // Returns: true (matches first pattern)
- *
- * testPatterns('/checkout', ['^/category.*', '^/search.*']);
- * // Returns: false (matches no patterns)
- * ```
- */
-declare function testPatterns(pathname: string, patterns: string[]): boolean;
+
 /**
  * Main function: Determines if a pathname should route to Storefront Next
  * or be proxied/redirected to SFRA/legacy backend.
@@ -296,170 +241,6 @@ declare function testPatterns(pathname: string, patterns: string[]): boolean;
  * ```
  */
 declare function shouldRouteToNext(pathname: string, routingRules?: string): boolean;
-/**
- * Clears the regex cache. Useful for testing or when routing rules change.
- *
- * @example
- * ```typescript
- * clearCache();
- * // All cached regex patterns are removed
- * ```
- */
-declare function clearCache(): void;
-//#endregion
-//#region src/server/config.d.ts
-/**
- * Server configuration extracted from environment variables
- */
-interface ServerConfig {
-  commerce: {
-    api: {
-      shortCode: string;
-      organizationId: string;
-      clientId: string;
-      proxy: string;
-      proxyHost?: string;
-    };
-  };
-}
-/**
- * This is a temporary function before we move the config implementation from
- * template-retail-rsc-app to the SDK.
- *
- * @ TODO: Remove this function after we move the config implementation from
- * template-retail-rsc-app to the SDK.
- *
- */
-declare function loadConfigFromEnv(): ServerConfig;
-/**
- * Load storefront-next project configuration from config.server.ts.
- * Requires projectDirectory to be provided.
- *
- * @param projectDirectory - Project directory to load config.server.ts from
- * @throws Error if config.server.ts is not found or invalid
- */
-declare function loadProjectConfig(projectDirectory: string): Promise<ServerConfig>;
-//#endregion
-//#region src/server/modes.d.ts
-/**
- * Copyright 2026 Salesforce, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-type ServerMode = 'development' | 'preview' | 'production';
-/**
- * Feature flags for each server mode
- */
-interface ServerModeFeatures {
-  /** Enable Commerce API proxy middleware to forward /mobify/proxy/api requests to SCAPI */
-  enableProxy: boolean;
-  /** Enable static file serving from build/client directory */
-  enableStaticServing: boolean;
-  /** Enable gzip/brotli compression middleware for responses */
-  enableCompression: boolean;
-  /** Enable HTTP request/response logging */
-  enableLogging: boolean;
-  /** Enable patching of asset URLs with bundle path (for CDN deployment) */
-  enableAssetUrlPatching: boolean;
-}
-//#endregion
-//#region src/server/index.d.ts
-interface ServerOptions extends Partial<ServerModeFeatures> {
-  /** Server mode: development (with Vite), preview (preview), or production (minimal) */
-  mode: ServerMode;
-  /** Project root directory (optional, defaults to process.cwd()) */
-  projectDirectory?: string;
-  /** Server configuration (optional, will load from env vars if not provided) */
-  config?: ServerConfig;
-  /** Server port (optional, for logging) */
-  port?: number;
-  /** Vite dev server instance (required for development mode) */
-  vite?: ViteDevServer;
-  /** React Router server build (required for preview/production modes) */
-  build?: ServerBuild;
-  /** Enable streaming of responses */
-  streaming?: boolean;
-}
-/**
- * Create a unified Express server for development, preview, or production mode
- */
-declare function createServer(options: ServerOptions): Promise<Express>;
-//#endregion
-//#region src/extensibility/extension-config.d.ts
-/**
- * Copyright 2026 Salesforce, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-type ExtensionMeta = {
-  name: string;
-  description: string;
-  installationInstructions: string;
-  uninstallationInstructions: string;
-  folder: string;
-  dependencies: string[];
-  defaultOn?: boolean;
-};
-declare const ExtensionConfig: {
-  extensions: Record<string, ExtensionMeta>;
-};
-//#endregion
-//#region src/extensibility/trim-extensions.d.ts
-type ExtensionsSelection = Record<string, boolean>;
-declare function trimExtensions(directory: string, selectedExtensions?: Partial<ExtensionsSelection>, extensionConfig?: typeof ExtensionConfig): void;
-//#endregion
-//#region src/cartridge-services/generate-cartridge.d.ts
-/**
- * Options for generateMetadata function
- */
-interface GenerateMetadataOptions {
-  /**
-   * Optional array of specific file paths to process.
-   * If provided, only these files will be processed and existing cartridge files will NOT be deleted.
-   * If omitted, the entire src/ directory will be scanned and all existing cartridge files will be deleted first.
-   */
-  filePaths?: string[];
-  /**
-   * Whether to run ESLint with --fix on generated JSON files to format them according to project settings.
-   * Defaults to true.
-   */
-  lintFix?: boolean;
-  /**
-   * If true, scans files and reports what would be generated without actually writing any files or deleting directories.
-   * Defaults to false.
-   */
-  dryRun?: boolean;
-}
-/**
- * Result returned by generateMetadata function
- */
-interface GenerateMetadataResult {
-  componentsGenerated: number;
-  pageTypesGenerated: number;
-  aspectsGenerated: number;
-  totalFiles: number;
-}
-declare function generateMetadata(projectDirectory: string, metadataDirectory: string, options?: GenerateMetadataOptions): Promise<GenerateMetadataResult>;
 //#endregion
-export { type GenerateMetadataOptions, type GenerateMetadataResult, type HybridProxyPluginOptions, type StorefrontNextTargetsConfig, type UITargetDevModeConfig, clearCache, createServer, storefrontNextTargets as default, extractPatterns, generateMetadata, hybridProxyPlugin, loadConfigFromEnv, loadProjectConfig, shouldRouteToNext, testPatterns, transformTargetPlaceholderPlugin, trimExtensions, uiTargetDevModePlugin };
+export { type HybridProxyPluginOptions, type StorefrontNextTargetsConfig, type UITargetDevModeConfig, storefrontNextTargets as default, hybridProxyPlugin, shouldRouteToNext, transformTargetPlaceholderPlugin, uiTargetDevModePlugin };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":["ExtensionMeta","ExtensionConfig","Record","default"],"sources":["../src/plugins/staticRegistry.ts","../src/plugins/eventInstrumentationValidator.ts","../src/storefront-next-targets.ts","../src/plugins/transformTargets.ts","../src/plugins/uiTargetDevMode.ts","../src/plugins/hybridProxy.ts","../src/plugins/ecdnMatcher.ts","../src/server/config.ts","../src/server/modes.ts","../src/server/index.ts","../src/extensibility/extension-config.d.ts","../src/extensibility/trim-extensions.ts","../src/cartridge-services/generate-cartridge.ts"],"sourcesContent":["/**\n * Copyright 2026 Salesforce, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nexport type ExtensionMeta = {\n    name: string;\n    description: string;\n    installationInstructions: string;\n    uninstallationInstructions: string;\n    folder: string;\n    dependencies: string[];\n    defaultOn?: boolean;\n};\n\ndeclare const ExtensionConfig: {\n    extensions: Record<string, ExtensionMeta>;\n};\n\nexport default ExtensionConfig;\n"],"mappings":";;;;;;;AMgGA;AA8CA;AA0BA;UNjHiB,0BAAA;;;AOjCjB;AAoBA;EAgDsB,aAAA,CAAA,EAAA,MAAiB;;;;AC3EvC;AAKA;;;;ACkCA;;;EAQa,kBAAA,CAAA,EAAA,MAAA;EAMF;;;;EA4BW,WAAA,CAAA,EAAA,OAAY;;;;;;;;ANrElB,UFDC,mCAAA,CEWc;;;;ACK/B;EA4CgB,UAAA,CAAA,EAAA,MAAA;;;;AC3BhB;EA2KgB,SAAA,CAAA,EAAA,MAAA,EAAiB;;;;ACzKjC;EAmCgB,aAAA,CAAA,EAAY,OAAA;AA8C5B;;;;;AHnHA;;UDUiB,2BAAA;;AEKjB;AA4CA;;;;AC3BA;AA2KA;;;;ACzKA;AAmCA;AA8CA;AA0BA;;;;AClJA;AAoBA;AAgDA;;;;EC3EY;AAKZ;;;;ACkCA;;;EAQa,cAAA,CAAA,EPSQ,0BOTR;EAMF;;;;AA4BX;;;;EAAmE,6BAAA,CAAA,EPf/B,mCOe+B,GAAA,KAAA;;;;ACjFnE;AAQE;;;;ACDoD;AAIrB;;;;;;;;AC8uBjC;AAwBA;AA8CA;AAGc,iBV1uBE,qBAAA,CU0uBF,MAAA,CAAA,EV1uBgC,2BU0uBhC,CAAA,EV1uBmE,MU0uBnE,EAAA;;;iBTtzBE,gCAAA,CAAA;;;yBAUe;;EHkBd,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,EAAA,EAAA,MAA0B,CAAA,EAAA;;;;AC7B3C,CAAA;;;UGgBiB,qBAAA;;;ADfjB;;;;ACeA;AA4CA;;;;EC3BiB;AA2KjB;;;;ACzKA;EAmCgB,OAAA,CAAA,EFlCF,MEkCc,CAAA,MAAA,EAAA,MAAA,CAAA;AA8C5B;AA0BA;;;;AClJA;AAoBA;AAgDA;;;;AC3EA;AAKA;;;;ACkCA;;;;;;AAAuC,iBLgCvB,qBAAA,CKhCuB,MAAA,CAAA,ELgCO,qBKhCP,CAAA,ELgCoC,MKhCpC;;;;AAAQ,UJK9B,wBAAA,CIL8B;EAErC;EAMG,OAAA,EAAA,OAAA;EAMF;EAGC,YAAA,EAAA,MAAA;EAjB2B;EAAO,YAAA,EAAA,MAAA;EA0CxB;;;;;;;;ACjFtB;AAQE;;;;ECGG;EAOmB,MAAA,CAAA,EAAA,MAAA;;;;;;;;;;;;;;;iBNqMR,iBAAA,UAA2B,2BAA2B;;;;;;;;;AL/KtE;;;;AC7BA;;;;ACWA;AAkEA;;;;AC5EA;;;;ACeA;AA4CA;;;;AC3BA;AA2KA;;;;ACzKA;AAmCA;AA8CgB,iBAjFA,eAAA,CAiFiB,UAAA,EAAA,MAAA,CAAA,EAAA,MAAA,EAAA;AA0BjC;;;;AClJA;AAoBA;AAgDA;;;;AC3EA;AAKA;;;;ACkCA;;AAEU,iBHwCM,YAAA,CGxCN,QAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,EAAA,CAAA,EAAA,OAAA;;;;;;AAwCV;;;;;;;;ACjFA;AAQE;;;;ACGG,iBLoHW,iBAAA,CKpHW,QAAM,EAAA,MAAA,EAAA,YAAA,CAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAAA;;;;;;;;AC8uBjC;AAwBiB,iBNxnBD,UAAA,CAAA,CMwnBuB,EAAA,IAAA;;;;;;UL1wBtB,YAAA;;;MPiCA,SAAA,EAAA,MAAA;;;;MC7BA,SAAA,CAAA,EAAA,MAAA;;;;ACWjB;AAkEA;;;;AC5EA;;;iBIegB,iBAAA,CAAA,GAAqB;AHArC;AA4CA;;;;AC3BA;AA2KA;iBE5IsB,iBAAA,4BAA6C,QAAQ;;;;;;;;;APnC3E;;;;AC7BA;;;;ACWA;AAkEgB,KMxFJ,UAAA,GNwFI,aAAqB,GAAS,SAAA,GAAA,YAAA;;;;AC5E9B,UKPC,kBAAA,CLOD;;;;ECeC,mBAAA,EAAA,OAAqB;EA4CtB;;;;EC3BC;EA2KD,sBAAiB,EAAA,OAAA;;;;UIhLhB,aAAA,SAAsB,QAAQ;;QAErC;ELdO;EA4CD,gBAAA,CAAA,EAAA,MAAqB;;WKxBxB;;EJHI,IAAA,CAAA,EAAA,MAAA;EA2KD;SIlKL;;UAGC;EHVI;EAmCA,SAAA,CAAA,EAAA,OAAY;AA8C5B;AE/HA;AAKA;;iBC4EsB,YAAA,UAAsB,gBAAgB,QAAQ;;;;;;;;;ATzCpE;;;;AC7BA;;;;ACWA;AAkEgB,KQxFJA,aAAAA,GRwFyB;;;;EC5ErB,0BAAA,EAAA,MAAA;;;;ACehB,CAAA;cMjBcC;cACEC,eAAeF;;;;KCA1B,mBAAA,GAAsB;iBAOH,cAAA,yCAEC,QAAQ,+CACJ;;;;;;AXmBZ,UYitBA,uBAAA,CZjtB0B;;;;AC7B3C;;;;ACWA;AAkEA;;;;AC5EA;;;;ACeA;AA4CA;;;UQ0sBiB,sBAAA;EPruBA,mBAAA,EAAA,MAAwB;EA2KzB,kBAAA,EAAiB,MAAA;;;;ACzKjB,iBMixBM,gBAAA,CNjxBS,gBAAA,EAAA,MAAA,EAAA,iBAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EMoxBjB,uBNpxBiB,CAAA,EMqxB5B,ONrxB4B,CMqxBpB,sBNrxBoB,CAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/plugins/staticRegistry.ts","../src/plugins/eventInstrumentationValidator.ts","../src/storefront-next-targets.ts","../src/plugins/transformTargets.ts","../src/plugins/uiTargetDevMode.ts","../src/plugins/hybridProxy.ts","../src/plugins/ecdnMatcher.ts"],"sourcesContent":[],"mappings":";;;;;;;;UAuDiB,0BAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;AG5BjB;;UFDiB,mCAAA;;AGgBjB;AA4CA;;;;AC1BA;AA+PA;;;;AC7KA;;;;;;;;;;;AFpGiB,UFHA,2BAAA,CEuBH;EAwBE;;;;AC1BhB;AA+PA;;;;AC7KA;;;;;;;;;;;;;;;;;;;;;;;mBJrEqB;;;;;;;;;kCAUe;;;;;;;;;;;;;;;;;;;;;iBAsBpB,qBAAA,UAA8B,8BAAmC;;;iBC9EjE,gCAAA,CAAA;;;EH4BC,cAAA,CAAA,MAAA,EGlBc,cHkBY,CAAA,EAAA,IAAA;;;;IC7B1B,GAAA,EAAA,IAAA;;;;;UGgBA,qBAAA;EDfD;;;;ECeC,OAAA,CAAA,EAAA,OAAA;EA4CD;;;;AC1BhB;EA+PgB,cAAA,CAAA,EAAA,MAAiB;;;;AC7KjC;;;YFhFc;;;;;;;;;;;;;;;;;;;;;;;iBAwBE,qBAAA,UAA8B,wBAA6B;;;;UC1B1D,wBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+PD,iBAAA,UAA2B,2BAA2B;;;;;;;;;;;;;;;;;;;;;;iBC7KtD,iBAAA"}