@salesforce/storefront-next-dev 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,327 @@
+import { Project } from "ts-morph";
+import { Express } from "express";
+import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+import { ServerBuild } from "react-router";
+
+//#region src/plugins/staticRegistry.d.ts
+
+/**
+ * Configuration options for the static registry plugin
+ */
+interface StaticRegistryPluginConfig {
+  /**
+   * Path to the components directory to scan
+   * @default 'src/components'
+   */
+  componentPath?: string;
+  /**
+   * Path to the registry file to update
+   * Note: The registry file must contain STATIC_REGISTRY_START and STATIC_REGISTRY_END markers
+   * and must export a 'registry' variable (or use registryIdentifier to specify a different name)
+   * @default 'src/lib/registry.ts'
+   */
+  registryPath?: string;
+  /**
+   * Name of the registry variable to use in generated code
+   * @default 'registry'
+   */
+  registryIdentifier?: string;
+  /**
+   * Whether to fail the build on registry generation errors
+   * @default true
+   */
+  failOnError?: boolean;
+  /**
+   * Enable verbose logging
+   * @default false
+   */
+  verbose?: boolean;
+}
+//#endregion
+//#region src/plugins/eventInstrumentationValidator.d.ts
+
+/**
+ * Configuration options for the event instrumentation validator plugin
+ */
+interface EventInstrumentationValidatorConfig {
+  /**
+   * Path to config module relative to project root
+   * @default 'config.server.ts'
+   */
+  configPath?: string;
+  /**
+   * Directories to scan for trackEvent calls relative to project root
+   * @default ['src']
+   */
+  scanPaths?: string[];
+  /**
+   * Whether to fail the build on missing instrumentation
+   * @default false (warning only)
+   */
+  failOnMissing?: boolean;
+  /**
+   * Enable verbose logging
+   * @default false
+   */
+  verbose?: boolean;
+}
+//#endregion
+//#region src/plugin.d.ts
+
+/**
+ * Configuration options for the Storefront Next Vite plugin.
+ */
+interface StorefrontNextPluginsConfig {
+  /**
+   * Enable human-readable chunk file names for easier debugging in production builds.
+   * When enabled, chunk files will be named based on their source location
+   * rather than just the file name and random hashes.
+   *
+   * This is useful to identify the chunk files and is usually used in development,
+   * in conjunction with the bundle analyzer.
+   *
+   * Example:
+   *
+   * ```
+   * (package)-(pkg-name)-index.[hash].js
+   * (components)-(ui)-(inputs)-(TextField)-index.[hash].js
+   * ```
+   *
+   * Instead of:
+   *
+   * ```
+   * index.[hash].js
+   * ```
+   *
+   * @default false
+   */
+  readableChunkNames?: boolean;
+  /**
+   * Configuration for the static registry plugin that automatically generates
+   * component registrations based on @Component decorators.
+   *
+   * Set to `false` to disable the static registry plugin entirely.
+   *
+   * @default { componentPath: 'src/components', registryPath: 'src/lib/registry.ts' }
+   */
+  staticRegistry?: StaticRegistryPluginConfig;
+  /**
+   * Configuration for the event instrumentation validator plugin that validates
+   * all enabled analytics event toggles have corresponding trackEvent() calls.
+   *
+   * Set to `false` to disable the validator entirely.
+   *
+   * @default { configPath: 'config.server.ts', scanPaths: ['src'], failOnMissing: false }
+   */
+  eventInstrumentationValidator?: EventInstrumentationValidatorConfig | false;
+}
+/**
+ * Storefront Next Vite plugin that powers the React Router RSC app.
+ * Supports building and optimizing for the managed runtime environment.
+ *
+ * @param config - Configuration options for the plugin
+ * @returns {Plugin[]} An array of Vite plugins for Storefront Next functionality
+ *
+ * @example
+ * // With default options
+ * export default defineConfig({
+ *   plugins: [storefrontNextPlugins()]
+ * })
+ *
+ * @example
+ * // Disable readable chunk names
+ * export default defineConfig({
+ *   plugins: [storefrontNextPlugins({ readableChunkNames: false })]
+ * })
+ */
+declare function storefrontNextPlugins(config?: StorefrontNextPluginsConfig): Plugin[];
+//#endregion
+//#region src/plugins/transformPlugins.d.ts
+declare function transformPluginPlaceholderPlugin(): {
+  name: string;
+  enforce: "pre";
+  configResolved(config: ResolvedConfig): void;
+  buildStart(): void;
+  transform(code: string, id: string): {
+    code: string;
+    map: null;
+  } | null;
+};
+//#endregion
+//#region src/types.d.ts
+
+interface PushOptions {
+  projectDirectory: string;
+  buildDirectory?: string;
+  message?: string;
+  projectSlug?: string;
+  target?: string;
+  cloudOrigin?: string;
+  credentialsFile?: string;
+  user?: string;
+  key?: string;
+  wait?: boolean;
+}
+//#endregion
+//#region src/commands/push.d.ts
+/**
+ * Main function to push bundle to Managed Runtime
+ */
+declare function push(options: PushOptions): Promise<void>;
+//#endregion
+//#region src/server/config.d.ts
+/**
+ * Server configuration extracted from environment variables
+ */
+interface ServerConfig {
+  commerce: {
+    api: {
+      shortCode: string;
+      organizationId: string;
+      clientId: string;
+      siteId: string;
+      proxy: 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, verboseOverride?: boolean): 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 PushOptions, type StorefrontNextPluginsConfig, createServer, storefrontNextPlugins as default, generateMetadata, loadConfigFromEnv, loadProjectConfig, push, transformPluginPlaceholderPlugin, trimExtensions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["ExtensionMeta","ExtensionConfig","Record","default"],"sources":["../src/plugins/staticRegistry.ts","../src/plugins/eventInstrumentationValidator.ts","../src/plugin.ts","../src/plugins/transformPlugins.ts","../src/types.ts","../src/commands/push.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":";;;;;;;;;;AOeY,UPsCK,0BAAA,COtCK;EAKL;;;;ECYA,aAAA,CAAA,EAAc,MAAA;EAAgB;;;;;;EAAD,YAAA,CAAA,EAAA,MAAA;EA0BxB;;;;EAA6C,kBAAA,CAAA,EAAA,MAAA;;;;AC3CnE;EAUcC,WAAAA,CAAAA,EAAAA,OAEb;;;;ACJqD;EAW9B,OAAA,CAAA,EAAA,OAAc;;;;;;;;APRtB,UFFC,mCAAA,CEWc;;;;ACc/B;;;;AChBA;;;;ACXA;AAoBA;AAuDA;;;;AClFA;AAKA;;;;;;;AJMA;;UDKiB,2BAAA;;AEkBjB;;;;AChBA;;;;ACXA;AAoBA;AAuDA;;;;AClFA;AAKA;;;;ACYA;;;EAQa,kBAAA,CAAA,EAAA,OAAA;EAMF;;;;AAYX;;;;EAAmE,cAAA,CAAA,ENO9C,0BMP8C;;;;AC3CnE;AAQE;;;;ECGG,6BAAmB,CAAA,ERiDY,mCQjDH,GAAA,KAAA;AAAA;;;;;;;;AC8pBjC;AAwBA;AA8CA;;;;;;;;;;iBT7pBgB,qBAAA,UAA8B,8BAAmC;;;iBCvEjE,gCAAA,CAAA;;;yBASe;;EHkBd,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,EAAA,EAAA,MAA0B,CAAA,EAAA;;;;AC7B3C,CAAA;;;;UGyBiB,WAAA;;EIjBA,cAAA,CAAA,EAAc,MAAA;EAAgB,OAAA,CAAA,EAAA,MAAA;EAErC,WAAA,CAAA,EAAA,MAAA;EAMG,MAAA,CAAA,EAAA,MAAA;EAMF,WAAA,CAAA,EAAA,MAAA;EAGC,eAAA,CAAA,EAAA,MAAA;EAjB2B,IAAA,CAAA,EAAA,MAAA;EAAO,GAAA,CAAA,EAAA,MAAA;EA0BxB,IAAA,CAAA,EAAA,OAAA;;;;;;;iBHzBA,IAAA,UAAc,cAAc;;;;;;UCXjC,YAAA;;;MN+BA,SAAA,EAAA,MAAA;;;;MC7BA,KAAA,EAAA,MAAA;;;;ACOjB;AAkEA;;;;ACvEA;;;iBGgBgB,iBAAA,CAAA,GAAqB;AFOrC;;;;AChBA;;;iBCgEsB,iBAAA,4BAA6C,QAAQ;;;;;;;;;AN5C3E;;;;AC7BA;;;;ACOA;AAkEgB,KKlFJ,UAAA,GLkFI,aAAqB,GAAS,SAAA,GAAA,YAAA;;;;ACvE9B,UINC,kBAAA,CJMD;;;;ECuBC,mBAAW,EAAA,OAAA;;;;EChBN,aAAI,EAAA,OAAU;;;;;;UGDnB,aAAA,SAAsB,QAAQ;;QAErC;EJeO;;;WITJ;EHPS;;;SGaX;EFxBM;EAoBD,KAAA,CAAA,EEOJ,WFPI;EAuDM;;;;AClFtB;AAKA;iBCsCsB,YAAA,UAAsB,gBAAgB,QAAQ;;;;;;;;;ARLpE;;;;AC7BA;;;;ACOA;AAkEgB,KOlFJD,aAAAA,GPkFyB;;;;ECvErB,0BAAA,EAAA,MAAA;;;;ACuBhB,CAAA;cKxBcC;cACEC,eAAeF;AJO/B,CAAA;;;KKPK,mBAAA,GAAsB;iBAQH,cAAA,yCAEC,QAAQ,+CACJ;;;;;;AVgBZ,UWmoBA,uBAAA,CXnoB0B;;;;AC7B3C;;;;ACOA;AAkEA;;;;ACvEA;;;;ACuBA;;;;AChBsB,UM+qBL,sBAAA,CN/qBiC;;;;ECXjC,UAAA,EAAA,MAAY;AAoB7B;AAuDsB,iBK6pBA,gBAAA,CL7pBqD,gBAAR,EAAO,MAAA,EAAA,iBAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EKgqB5D,uBLhqB4D,CAAA,EKiqBvE,OLjqBuE,CKiqB/D,sBLjqB+D,CAAA"}