@lwrjs/types 0.9.0-alpha.13 → 0.9.0-alpha.15

package/build/config.d.ts

@@ -1,4 +1,4 @@
-import { AssetProvider, AssetTransformPlugin, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
+import { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -83,6 +83,7 @@ export interface LwrGlobalConfig {
     environment?: EnvironmentConfig;
     lwc?: LwcConfig;
     moduleProviders?: ServiceConfig[];
+    bundleProviders?: ServiceConfig[];
     resourceProviders?: ServiceConfig[];
     viewProviders?: ServiceConfig[];
     viewTransformers?: ServiceConfig[];
@@ -102,6 +103,7 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
     esmLoader: string;
     hooks: ServiceEntry[];
     moduleProviders: ServiceEntry[];
+    bundleProviders: ServiceEntry[];
     viewProviders: ServiceEntry[];
     viewTransformers: ServiceEntry[];
     resourceProviders: ServiceEntry[];
@@ -127,6 +129,7 @@ export interface ServerBuild {
 }
 export interface Services {
     moduleProviders: ResolvedServiceEntry<ModuleProvider>[];
+    bundleProviders: ResolvedServiceEntry<BundleProvider>[];
     viewProviders: ResolvedServiceEntry<ViewProvider>[];
     viewTransformers: ResolvedServiceEntry<ViewTransformPlugin>[];
     resourceProviders: ResolvedServiceEntry<ResourceProvider>[];

package/build/index.d.ts

@@ -163,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;
@@ -270,11 +271,18 @@ export interface ModuleRegistry {
     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>;
     getPublicApi(): PublicModuleRegistry;
 }
-export declare type PublicModuleRegistry = Pick<ModuleRegistry, 'getModule' | 'getModuleEntry' | 'resolveModuleUri'>;
+export declare type PublicModuleRegistry = Pick<ModuleRegistry, 'getModule' | 'getModuleEntry' | 'getLinkedModule' | '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>;
+    getPublicApi(): PublicModuleBundler;
 }
-export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle'>;
+export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle' | 'resolveModuleUri'>;
 export interface BundleRecord {
     imports?: BaseModuleReference[];
     dynamicImports?: BaseDynamicModuleReference[];
@@ -299,9 +307,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;
@@ -409,7 +417,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;
@@ -443,22 +451,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;
@@ -501,7 +493,6 @@ export interface MetricsConfig {
 export interface ServerContext {
     appObserver: LwrAppObserver;
     appEmitter: LwrAppEmitter;
-    compiler: Compiler;
     moduleRegistry: ModuleRegistry;
     moduleBundler: ModuleBundler;
     viewRegistry: ViewRegistry;
@@ -510,6 +501,7 @@ export interface ServerContext {
     appConfig: NormalizedLwrGlobalConfig;
     runtimeEnvironment: RuntimeEnvironment;
     watcherFactory?: WatcherFactory;
+    siteMetadata?: SiteMetadata;
 }
 export interface Observer<V> {
     next: (value: V) => void;
@@ -586,4 +578,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/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.9.0-alpha.13",
+    "version": "0.9.0-alpha.15",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,5 +29,5 @@
     "devDependencies": {
         "chokidar": "^3.5.3"
     },
-    "gitHead": "fa30915a685f6e8c5c2895d0c053d59145780123"
+    "gitHead": "f32f103d2d5e516daccce1be69f68acd7b4b86fb"
 }