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

package/dist/schema.d.ts

@@ -0,0 +1,78 @@
+//#region src/config/schema.d.ts
+/**
+ * Base configuration type for storefront-next projects.
+ *
+ * Generic parameter `App` represents the template's application config shape.
+ * The SDK does not prescribe what fields `app` must contain — templates define
+ * their own `AppConfig` type with SCAPI credentials, pages, features, etc.
+ * and pass it as `BaseConfig<AppConfig>`.
+ *
+ * The SDK accesses specific `app` fields (e.g., `commerce.api.clientId`) at
+ * runtime via the middleware validation, not via compile-time type constraints.
+ *
+ * @typeParam App - The template's application config shape (defaults to `Record<string, unknown>`)
+ *
+ * @example
+ * // In the template's types file:
+ * type AppConfig = { commerce: { api: {...} }; pages: {...}; features: {...} };
+ * type Config = BaseConfig<AppConfig>;
+ *
+ * // In config.server.ts:
+ * export default defineConfig<Config>({ metadata: {...}, app: {...} });
+ */
+type BaseConfig<App extends Record<string, unknown> = Record<string, unknown>> = {
+  metadata: {
+    projectName: string;
+    projectSlug: string;
+  };
+  runtime?: {
+    defaultMrtProject?: string;
+    defaultMrtTarget?: string;
+    ssrOnly?: string[];
+    ssrShared?: string[];
+    ssrParameters?: Record<string, string | number | boolean>;
+  };
+  app: App;
+};
+interface DefineConfigOptions {
+  /**
+   * Config paths that cannot be overridden by environment variables.
+   * Paths use double underscore separators and are matched case-insensitively.
+   *
+   * @example ['app__engagement'] — prevents PUBLIC__app__engagement__* from being set via env
+   */
+  protectedPaths?: string[];
+}
+/**
+ * Define a type-safe storefront configuration with IDE autocomplete.
+ *
+ * Automatically merges `PUBLIC__` prefixed environment variables into the config
+ * at load time. Validates env vars against the base config structure (strict mode —
+ * only allows overriding existing paths).
+ *
+ * Environment variables:
+ * - `PUBLIC__<path>` (optional): Override any config path using double underscore separators.
+ *   e.g. `PUBLIC__app__commerce__api__clientId=abc123` maps to `config.app.commerce.api.clientId`
+ * - `PUBLIC__app__pages__cart__quantityUpdateDebounce=1000` maps to a number (optimistic JSON parsing)
+ * - `PUBLIC__app__features__socialLogin__providers=["Apple","Google"]` maps to an array
+ *
+ * @param config - The base configuration object with all defaults
+ * @param options - Optional settings (e.g., protectedPaths to prevent env var overrides)
+ * @returns The config with environment variable overrides merged in
+ *
+ * @example
+ * // In config.server.ts:
+ * import { defineConfig } from '@salesforce/storefront-next-runtime/config';
+ *
+ * export default defineConfig({
+ *     metadata: { projectName: 'My Store', projectSlug: 'my-store' },
+ *     app: {
+ *         commerce: { api: { clientId: '', organizationId: '', shortCode: '' }, sites: [] },
+ *         defaultSiteId: 'RefArch',
+ *     },
+ * }, { protectedPaths: ['app__engagement'] });
+ */
+declare function defineConfig<T extends BaseConfig>(config: T, options?: DefineConfigOptions): T;
+//#endregion
+export { DefineConfigOptions as n, defineConfig as r, BaseConfig as t };
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","names":[],"sources":["../src/config/schema.ts"],"sourcesContent":[],"mappings":";;AAsCA;;;;;;AAeA;AAuCA;;;;;;;;;;;;;KAtDY,uBAAuB,0BAA0B;;;;;;;;;;oBAUrC;;OAEf;;UAGQ,mBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuCD,uBAAuB,oBAAoB,aAAa,sBAAsB"}

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","names":[],"sources":["../src/config/types.ts"],"sourcesContent":[],"mappings":";;AAiBA;AAKA;AAYA;;;;;;;;;;;;KAjBY,MAAA;;;;KAKA,IAAA;;;;;;;;;oBASU,MAAM;;KAGhB,GAAA"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/config/types.ts"],"sourcesContent":[],"mappings":";;AAgBA;AAKA;AAYA;;;;;;;;;;;;KAjBY,MAAA;;;;KAKA,IAAA;;;;;;;;;oBASU,MAAM;;KAGhB,GAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/storefront-next-runtime",
-  "version": "0.2.0-alpha.2",
+  "version": "0.3.0-alpha.0",
   "description": "Runtime agnostic libraries for SFCC Storefront Next",
   "type": "module",
   "exports": {
@@ -50,6 +50,12 @@
         "default": "./dist/config.js"
       }
     },
+    "./config/load-config": {
+      "import": {
+        "types": "./dist/config-load.d.ts",
+        "default": "./dist/config-load.js"
+      }
+    },
     "./events": {
       "import": {
         "types": "./dist/events.d.ts",