@lwrjs/types 0.9.0-alpha.12 → 0.9.0-alpha.14

package/build/config.d.ts

@@ -1,4 +1,4 @@
-import { CacheResponse, RenderOptions, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, Specifier, ViewParams, ViewRequest, ViewResponse } from './index';
+import { AssetProvider, AssetTransformPlugin, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -100,6 +100,7 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
     lwrVersion: string;
     amdLoader: string;
     esmLoader: string;
+    hooks: ServiceEntry[];
     moduleProviders: ServiceEntry[];
     viewProviders: ServiceEntry[];
     viewTransformers: ServiceEntry[];
@@ -111,10 +112,30 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
 export interface StaticSiteGenerator {
     outputDir?: string;
     locales?: string[];
+    skipCleanOutputDir?: boolean;
     skipBaseDocumentGeneration?: boolean;
     _additionalRoutePaths?: string[];
     _additionalModules?: string[];
 }
+export interface ServerBuild {
+    appConfig: NormalizedLwrGlobalConfig;
+    runtimeEnvironment: RuntimeEnvironment;
+    globalData: GlobalData;
+    services: Services;
+    routes: Route<NormalizedLwrRoute>[];
+    errorRoutes: Route<NormalizedLwrErrorRoute>[];
+}
+export interface Services {
+    moduleProviders: ResolvedServiceEntry<ModuleProvider>[];
+    viewProviders: ResolvedServiceEntry<ViewProvider>[];
+    viewTransformers: ResolvedServiceEntry<ViewTransformPlugin>[];
+    resourceProviders: ResolvedServiceEntry<ResourceProvider>[];
+    assetProviders: ResolvedServiceEntry<AssetProvider>[];
+    assetTransformers: ResolvedServiceEntry<AssetTransformPlugin>[];
+}
+export declare type Route<T extends LwrBaseRoute> = (T extends LwrRoute ? Omit<NormalizedLwrRoute, 'routeHandler'> : Omit<NormalizedLwrErrorRoute, 'routeHandler'>) & {
+    routeHandler?: RouteHandlerFunction;
+};
 interface AssetConfigCommon {
     urlPath: string;
     alias?: string;
@@ -137,6 +158,7 @@ export interface NormalizedLwcConfig extends Omit<LwcConfig, 'interchangeableMod
 }
 export declare type ServiceEntry = [string, any?];
 export declare type ServiceConfig = string | ServiceEntry;
+export declare type ResolvedServiceEntry<T extends LwrService> = [ServiceCtor<T>, any?];
 export interface BundleConfig {
     exclude?: string[];
     UNSAFE_lwrDefaultExclude?: string[];

package/build/index.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+import type { WatchOptions } from 'chokidar';
 import { EventEmitter } from 'events';
 import fs from 'fs';
 import { Readable } from 'stream';
@@ -162,9 +163,10 @@ export interface ServerModeConfig {
     };
     featureFlags: FeatureFlags;
 }
-export interface FeatureFlags {
-    LEGACY_LOADER: boolean;
-    SSR_STATIC_BUNDLES: boolean;
+export interface FeatureFlags extends Record<string, boolean | undefined> {
+    LEGACY_LOADER?: boolean;
+    SSR_STATIC_BUNDLES?: boolean;
+    SSR_SANDBOX_WORKER?: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
     apiVersion: string;
@@ -200,6 +202,11 @@ export interface BootstrapRuntimeEnvironment extends RuntimeEnvironment {
     bootstrapImports?: string[];
     bootstrapDynamicImports?: string[];
 }
+export type { WatchOptions } from 'chokidar';
+export interface WatcherFactory {
+    createFileWatcher(options?: WatchOptions): Watcher;
+    setupWatcher(onModuleChange: Function): Watcher;
+}
 export interface Watcher extends EventEmitter {
     add(paths: string | ReadonlyArray<string>): void;
     unwatch(paths: string | ReadonlyArray<string>): void;
@@ -253,7 +260,7 @@ export interface ModuleProvider {
 }
 export declare type LwrService = ModuleProvider | ResourceProvider | ViewProvider | AssetProvider | HooksPlugin | AssetTransformPlugin | ViewTransformPlugin;
 export interface ServiceCtor<T extends LwrService, R extends Record<string, Json> = {}> {
-    new (moduleProviderConfig: R, serviceProviderConfig?: any, ...args: any[]): T;
+    new (providerConfig: R, serviceProviderConfig?: any, ...args: any[]): T;
 }
 export interface ModuleRegistry {
     name: string;
@@ -265,10 +272,16 @@ export interface ModuleRegistry {
     getPublicApi(): PublicModuleRegistry;
 }
 export declare type PublicModuleRegistry = Pick<ModuleRegistry, 'getModule' | 'getModuleEntry' | 'resolveModuleUri'>;
+export interface BundleProvider {
+    name: string;
+    bundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams: RuntimeParams, configOverrides?: BundleConfig): Promise<BundleDefinition | undefined>;
+}
 export interface ModuleBundler {
+    addBundleProviders(providers: BundleProvider[]): void;
     getModuleBundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams?: RuntimeParams, bundleConfigOverrides?: BundleConfig): Promise<BundleDefinition>;
+    resolveModuleUri<R extends RuntimeEnvironment, S extends string | undefined>(moduleId: Required<Pick<ModuleId, 'specifier' | 'version'>>, runtimeEnvironment: R, runtimeParams?: RuntimeParams, signature?: S): S extends string ? string : Promise<string>;
 }
-export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle'>;
+export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle' | 'resolveModuleUri'>;
 export interface BundleRecord {
     imports?: BaseModuleReference[];
     dynamicImports?: BaseDynamicModuleReference[];
@@ -293,9 +306,9 @@ export interface ProviderAppConfig {
     amdLoader: string;
     esmLoader: string;
     environment?: EnvironmentConfig;
+    bundleConfig: BundleConfig;
 }
 export interface ProviderContext {
-    compiler: Compiler;
     appObserver: Pick<LwrAppObserver, 'onModuleDefinitionChange' | 'onModuleSourceChange' | 'onAssetSourceChange' | 'onViewSourceChange'>;
     appEmitter: Pick<LwrAppEmitter, 'notifyModuleDefinitionChanged' | 'notifyAssetSourceChanged' | 'notifyModuleSourceChanged' | 'notifyViewSourceChanged'>;
     moduleRegistry: PublicModuleRegistry;
@@ -305,6 +318,7 @@ export interface ProviderContext {
     assetRegistry: PublicAssetRegistry;
     config: ProviderAppConfig;
     runtimeEnvironment: RuntimeEnvironment;
+    watcherFactory?: WatcherFactory;
 }
 export interface ResourceIdentifier {
     specifier: string;
@@ -402,7 +416,7 @@ export interface AssetRegistry {
     getPublicApi(): PublicAssetRegistry;
 }
 export declare type PublicAssetRegistry = Pick<AssetRegistry, 'getAsset' | 'resolveAssetUri'>;
-export interface CompilerConfig {
+export interface LwcCompilerConfig {
     name: string;
     namespace?: string;
     filename: string;
@@ -436,22 +450,6 @@ export interface CompilerResult {
 export interface BundleFiles {
     [filename: string]: string;
 }
-export interface Compiler {
-    convertToAmd(source: string, { id }: {
-        id: string;
-    }): Promise<CompilerResult>;
-    getModuleMetadata(compiledSource: string): Promise<Partial<CompiledMetadata>>;
-    lockerize(compiledModule: ModuleCompiled, lockerConfig: LwrLockerConfig, sourcemap: boolean): CompilerResult;
-    minifyJavascript(source: string): Promise<CompilerResult>;
-    parseJavascript(source: string, options: ParseOptions): Promise<CompilerResult>;
-    minifyCSS(source: string): Promise<CompilerResult>;
-}
-export interface ParseOptions {
-    envMode: string;
-}
-export interface CompilerContext {
-    runtimeEnvironment: RuntimeEnvironment;
-}
 export interface ClientBootstrapConfig {
     appId?: string;
     bootstrapModule: string;
@@ -494,7 +492,6 @@ export interface MetricsConfig {
 export interface ServerContext {
     appObserver: LwrAppObserver;
     appEmitter: LwrAppEmitter;
-    compiler: Compiler;
     moduleRegistry: ModuleRegistry;
     moduleBundler: ModuleBundler;
     viewRegistry: ViewRegistry;
@@ -502,6 +499,8 @@ export interface ServerContext {
     assetRegistry: AssetRegistry;
     appConfig: NormalizedLwrGlobalConfig;
     runtimeEnvironment: RuntimeEnvironment;
+    watcherFactory?: WatcherFactory;
+    siteMetadata?: SiteMetadata;
 }
 export interface Observer<V> {
     next: (value: V) => void;
@@ -578,4 +577,54 @@ export interface LwrStringBuilder {
     toString(): string;
     original: string;
 }
+export interface SiteMetadata {
+    /**
+     * Get the current metadata about the pre-built module bundles for the site.
+     */
+    getSiteBundles(): SiteBundles;
+    /**
+     * Get the current metadata about the pre-built resources for the site.
+     */
+    getSiteResources(): SiteResources;
+    /**
+     * Get the current metadata about the pre-built assets for the site.
+     */
+    getSiteAssets(): SiteAssets;
+    /**
+     * To save out metadata for the current site
+     * @param staticRoot
+     * @returns
+     */
+    persistSiteMetadata(): Promise<void>;
+}
+export interface SiteBundles {
+    environment: SiteBundlesEnvironment;
+    bundles: Record<string, SiteBundle>;
+}
+export interface SiteResources {
+    environment: SiteResourcesEnvironment;
+    resources: Record<string, SiteArtifact>;
+}
+export interface SiteAssets {
+    assets: Record<string, SiteArtifact>;
+}
+export interface SiteBundlesEnvironment {
+    format: ModuleFormat;
+    featureFlags?: FeatureFlags;
+}
+export interface SiteResourcesEnvironment {
+    format: ModuleFormat;
+    featureFlags?: FeatureFlags;
+}
+export interface SiteArtifact {
+    path: string;
+    mimeType?: string;
+}
+export interface SiteBundle extends SiteArtifact {
+    version?: Version;
+    bundleRecord: {
+        includedModules: string[];
+        imports: string[];
+    };
+}
 //# sourceMappingURL=index.d.ts.map

package/build/views.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { RouteHandlerFunction, RouteHandlerView, View } from './config.js';
-import { AssetSource, AssetUri, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrErrorRoute, LwrRoute, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, TransformPluginContext } from './index.js';
+import { LwrErrorRoute, LwrRoute, Route, RouteHandlerFunction, RouteHandlerView, View } from './config.js';
+import { AssetSource, AssetUri, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, TransformPluginContext } from './index.js';
 export declare type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
@@ -185,9 +185,9 @@ export interface ViewRegistry {
 }
 export declare type PublicViewRegistry = Pick<ViewRegistry, 'getView' | 'getViewDefinition'>;
 export interface ViewHandler {
-    getViewContent(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
-    getViewJson(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
-    getViewConfiguration(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse | undefined>;
+    getViewContent(viewRequest: ViewRequest, route: Route<LwrRoute | LwrErrorRoute>, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
+    getViewJson(viewRequest: ViewRequest, route: Route<LwrRoute | LwrErrorRoute>, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
+    getViewConfiguration(viewRequest: ViewRequest, route: Route<LwrRoute | LwrErrorRoute>, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse | undefined>;
 }
 export interface SsrRequestContext {
     props: Json;

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.9.0-alpha.12",
+    "version": "0.9.0-alpha.14",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -26,5 +26,8 @@
     "engines": {
         "node": ">=14.15.4 <19"
     },
-    "gitHead": "f532aa80039acf04e9ad511ed090a2b368837014"
+    "devDependencies": {
+        "chokidar": "^3.5.3"
+    },
+    "gitHead": "64e0ba617151429da6e09f1a9686628f64183d25"
 }