@salesforce/storefront-next-runtime 0.1.1 → 0.2.0-alpha.0

package/dist/apply-url-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-url-config.js","names":["prefixPatterns: string[]","excludedRoutes: RouteConfigEntry[]","includedRoutes: RouteConfigEntry[]","duplicates: RouteConfigEntry[]"],"sources":["../src/utils/index.ts","../src/multi-site/apply-url-config.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 */\n\n/**\n * Creates a matcher function from an array of path patterns.\n * Supports `/**` suffix wildcards (e.g. '/resource/**', '/action/**').\n * Exact paths without wildcards are matched literally.\n */\nexport function createPatternMatcher(patterns: string[]): (path: string) => boolean {\n    const exactMatches = new Set<string>();\n    const prefixPatterns: string[] = [];\n\n    for (const pattern of patterns) {\n        if (pattern.endsWith('/**')) {\n            prefixPatterns.push(pattern.slice(0, -3));\n        } else {\n            exactMatches.add(pattern);\n        }\n    }\n\n    return (path: string) => {\n        if (exactMatches.has(path)) return true;\n        return prefixPatterns.some((prefix) => path === prefix || path.startsWith(`${prefix}/`));\n    };\n}\n","/**\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 */\nimport type { RouteConfigEntry } from '@react-router/dev/routes';\nimport { createPatternMatcher } from '../utils';\nimport type { Url } from '../config/types';\n\nconst DEFAULT_EXCLUDED_ROUTES = ['/resource/**', '/action/**'];\n\n/**\n * Separates routes into excluded (stay at root) and included (go under prefix).\n */\nexport function partitionRoutes(\n    routes: RouteConfigEntry[],\n    excludePatterns: string[]\n): { excludedRoutes: RouteConfigEntry[]; includedRoutes: RouteConfigEntry[] } {\n    const isExcluded = createPatternMatcher(excludePatterns);\n    const excludedRoutes: RouteConfigEntry[] = [];\n    const includedRoutes: RouteConfigEntry[] = [];\n\n    for (const route of routes) {\n        // Normalize path for matching — ensure leading slash so patterns like '/resource/**' work\n        // regardless of whether the route path comes with or without a leading slash.\n        // E.g Some routes comes from React Router flatRoutes objects where the path has no leading splash\n        const matchPath = route.path?.startsWith('/') ? route.path : `/${route.path}`;\n        if (route.path && isExcluded(matchPath)) {\n            excludedRoutes.push(route);\n        } else {\n            includedRoutes.push(route);\n        }\n    }\n\n    return { excludedRoutes, includedRoutes };\n}\n\n/**\n * Normalizes route paths by stripping leading `/` so they're relative under a\n * parent route (React Router requirement).\n */\nexport function normalizeRoutePaths(routes: RouteConfigEntry[]): RouteConfigEntry[] {\n    return routes.map((route) => ({\n        ...route,\n        // Check for leading splash because React Router route object can contain no leading splash for a child route\n        // E.g Some routes comes from React Router flatRoutes objects where the path has no leading splash\n        path: route.path?.startsWith('/') ? route.path.slice(1) : route.path,\n    }));\n}\n\n/**\n * Creates the `multi-site-wrapper` parent route entry with the given prefix.\n */\nexport function createPrefixWrapper(\n    prefix: string,\n    children: RouteConfigEntry[],\n    wrapperFile: string\n): RouteConfigEntry {\n    return {\n        id: 'multi-site-wrapper',\n        file: wrapperFile,\n        path: prefix.slice(1),\n        children,\n    };\n}\n\n/**\n * Finds the root index route (`/`) and duplicates it with its parent layout.\n * Looks at the top level for pathless layouts whose direct children include an index route.\n * e.g. _app (pathless) → _app._index (index: true)\n * Returns: _app--root-duplicate → _app._index--root-duplicate\n */\nexport function cloneRootIndexRoutes(routes: RouteConfigEntry[]): RouteConfigEntry[] {\n    const duplicates: RouteConfigEntry[] = [];\n\n    for (const route of routes) {\n        if (route.index === true) {\n            duplicates.push({\n                ...route,\n                id: `${route.id}--root-duplicate`,\n            });\n        } else if (!route.path && route.children) {\n            const indexChild = route.children.find((child) => child.index === true);\n            if (indexChild) {\n                duplicates.push({\n                    ...route,\n                    id: `${route.id}--root-duplicate`,\n                    children: [{ ...indexChild, id: `${indexChild.id}--root-duplicate` }],\n                });\n            }\n        }\n    }\n\n    return duplicates;\n}\n\n/**\n * Applies multi-site URL configuration to a set of route entries.\n *\n * Wraps non-excluded routes under a parent route with the configured URL prefix\n * (e.g. `/:siteId/:localeId`), while keeping excluded routes (action/resource by default)\n * at the root level. The homepage index route (and its parent layout) is always\n * duplicated at `/` so the root URL still serves content.\n *\n * @param options - Configuration for URL customisation.\n * @param options.routes - The flat route entries discovered from the filesystem.\n * @param options.urlConfig - URL customisation configuration (prefix, excludeRoutes).\n * @param options.wrapperFile - Path to the wrapper component file, relative to appDirectory.\n * @returns The transformed route entries with prefix wrapping applied.\n */\nexport function applyUrlConfig(options: {\n    routes: RouteConfigEntry[];\n    urlConfig?: Url;\n    wrapperFile: string;\n}): RouteConfigEntry[] {\n    const { routes, urlConfig, wrapperFile } = options;\n    if (!urlConfig) return routes;\n    if (!urlConfig.prefix?.startsWith('/')) {\n        throw new Error(`urlConfig.prefix must start with a leading slash (\"/\"). Received: \"${urlConfig.prefix}\"`);\n    }\n    if (urlConfig.prefix === '/') return routes;\n\n    const excludePatterns = urlConfig.excludeRoutes ?? DEFAULT_EXCLUDED_ROUTES;\n\n    const { excludedRoutes, includedRoutes } = partitionRoutes(routes, excludePatterns);\n\n    const wrappableRoutes = normalizeRoutePaths(includedRoutes);\n    // the route that wraps the included routes under prefix\n    const wrapperRoute = createPrefixWrapper(urlConfig.prefix, wrappableRoutes, wrapperFile);\n\n    // duplicate the app root index to keep app homepage to server at '/'\n    const rootDuplicates = cloneRootIndexRoutes(includedRoutes);\n\n    return [...rootDuplicates, wrapperRoute, ...excludedRoutes];\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,qBAAqB,UAA+C;CAChF,MAAM,+BAAe,IAAI,KAAa;CACtC,MAAMA,iBAA2B,EAAE;AAEnC,MAAK,MAAM,WAAW,SAClB,KAAI,QAAQ,SAAS,MAAM,CACvB,gBAAe,KAAK,QAAQ,MAAM,GAAG,GAAG,CAAC;KAEzC,cAAa,IAAI,QAAQ;AAIjC,SAAQ,SAAiB;AACrB,MAAI,aAAa,IAAI,KAAK,CAAE,QAAO;AACnC,SAAO,eAAe,MAAM,WAAW,SAAS,UAAU,KAAK,WAAW,GAAG,OAAO,GAAG,CAAC;;;;;;AChBhG,MAAM,0BAA0B,CAAC,gBAAgB,aAAa;;;;AAK9D,SAAgB,gBACZ,QACA,iBAC0E;CAC1E,MAAM,aAAa,qBAAqB,gBAAgB;CACxD,MAAMC,iBAAqC,EAAE;CAC7C,MAAMC,iBAAqC,EAAE;AAE7C,MAAK,MAAM,SAAS,QAAQ;EAIxB,MAAM,YAAY,MAAM,MAAM,WAAW,IAAI,GAAG,MAAM,OAAO,IAAI,MAAM;AACvE,MAAI,MAAM,QAAQ,WAAW,UAAU,CACnC,gBAAe,KAAK,MAAM;MAE1B,gBAAe,KAAK,MAAM;;AAIlC,QAAO;EAAE;EAAgB;EAAgB;;;;;;AAO7C,SAAgB,oBAAoB,QAAgD;AAChF,QAAO,OAAO,KAAK,WAAW;EAC1B,GAAG;EAGH,MAAM,MAAM,MAAM,WAAW,IAAI,GAAG,MAAM,KAAK,MAAM,EAAE,GAAG,MAAM;EACnE,EAAE;;;;;AAMP,SAAgB,oBACZ,QACA,UACA,aACgB;AAChB,QAAO;EACH,IAAI;EACJ,MAAM;EACN,MAAM,OAAO,MAAM,EAAE;EACrB;EACH;;;;;;;;AASL,SAAgB,qBAAqB,QAAgD;CACjF,MAAMC,aAAiC,EAAE;AAEzC,MAAK,MAAM,SAAS,OAChB,KAAI,MAAM,UAAU,KAChB,YAAW,KAAK;EACZ,GAAG;EACH,IAAI,GAAG,MAAM,GAAG;EACnB,CAAC;UACK,CAAC,MAAM,QAAQ,MAAM,UAAU;EACtC,MAAM,aAAa,MAAM,SAAS,MAAM,UAAU,MAAM,UAAU,KAAK;AACvE,MAAI,WACA,YAAW,KAAK;GACZ,GAAG;GACH,IAAI,GAAG,MAAM,GAAG;GAChB,UAAU,CAAC;IAAE,GAAG;IAAY,IAAI,GAAG,WAAW,GAAG;IAAmB,CAAC;GACxE,CAAC;;AAKd,QAAO;;;;;;;;;;;;;;;;AAiBX,SAAgB,eAAe,SAIR;CACnB,MAAM,EAAE,QAAQ,WAAW,gBAAgB;AAC3C,KAAI,CAAC,UAAW,QAAO;AACvB,KAAI,CAAC,UAAU,QAAQ,WAAW,IAAI,CAClC,OAAM,IAAI,MAAM,sEAAsE,UAAU,OAAO,GAAG;AAE9G,KAAI,UAAU,WAAW,IAAK,QAAO;CAIrC,MAAM,EAAE,gBAAgB,mBAAmB,gBAAgB,QAFnC,UAAU,iBAAiB,wBAEgC;CAEnF,MAAM,kBAAkB,oBAAoB,eAAe;CAE3D,MAAM,eAAe,oBAAoB,UAAU,QAAQ,iBAAiB,YAAY;AAKxF,QAAO;EAAC,GAFe,qBAAqB,eAAe;EAEhC;EAAc,GAAG;EAAe"}

package/dist/component.types.d.ts

@@ -0,0 +1,87 @@
+import React from "react";
+
+//#region src/design/react/core/component.types.d.ts
+
+/**
+ * Default component constructor interface.
+ * Used to define default components that should be instantiated in a region.
+ */
+interface DefaultComponentConstructor {
+  /** Unique identifier for the component instance */
+  id: string;
+  /** Component type ID to instantiate */
+  typeId: string;
+  /** Component data/attributes */
+  data: Record<string, unknown>;
+}
+interface RegionDesignMetadata {
+  /**
+   * The id of the component or region.
+   */
+  id: string;
+  /**
+   * The name of the component or region.
+   */
+  name?: string;
+  /**
+   * Optional description for the region.
+   */
+  description?: string;
+  /**
+   * Maximum number of components allowed in the region.
+   */
+  maxComponents?: number;
+  /**
+   * A list of component ids that are part of this region.
+   */
+  componentIds?: string[];
+  /**
+   * A list of allowed component types in this region.
+   */
+  componentTypeInclusions?: string[];
+  /**
+   * A list of forbidden component types in this region.
+   */
+  componentTypeExclusions?: string[];
+  /**
+   * Default components to instantiate when the region is created.
+   */
+  defaultComponentConstructors?: DefaultComponentConstructor[];
+}
+interface ComponentDesignMetadata {
+  /**
+   * The id of the component or region.
+   */
+  id: string;
+  /**
+   * Whether the component is a fragment.
+   */
+  isFragment: boolean;
+  /**
+   * Whether the component is visible based on the current visiblity rules and context.
+   */
+  isVisible: boolean;
+  /**
+   * Whether the component has been localized in the current locale.
+   */
+  isLocalized: boolean;
+  /**
+   * The name of the component or region.
+   */
+  name?: string;
+  /**
+   * The region definitions for this component.
+   */
+  regionDefinitions?: RegionDesignMetadata[];
+}
+type ComponentDecoratorProps<TProps> = React.PropsWithChildren<{
+  designMetadata?: ComponentDesignMetadata;
+  visible?: boolean;
+  localized?: boolean;
+} & TProps>;
+type RegionDecoratorProps<TProps> = React.PropsWithChildren<{
+  designMetadata?: RegionDesignMetadata;
+} & TProps>;
+//#endregion
+export { RegionDesignMetadata as a, RegionDecoratorProps as i, ComponentDesignMetadata as n, DefaultComponentConstructor as r, ComponentDecoratorProps as t };
+//# sourceMappingURL=component.types.d.ts.map

package/dist/component.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.types.d.ts","names":[],"sources":["../src/design/react/core/component.types.ts"],"sourcesContent":[],"mappings":";;;;;;;;UAqBiB,2BAAA;;;;;;QAMP;;UAGO,oBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAgCkB;;UAGlB,uBAAA;;;;;;;;;;;;;;;;;;;;;;;;sBAwBO;;KAGZ,kCAAkC,KAAA,CAAM;mBAE3B;;;IAGjB;KAGI,+BAA+B,KAAA,CAAM;mBAExB;IACjB"}

package/dist/config.d.ts

@@ -0,0 +1,2 @@
+import { n as Site, r as Url, t as Locale } from "./types.js";
+export { type Locale, type Site, type Url };