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

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;
@@ -121,12 +121,14 @@ export interface ServerBuild {
     appConfig: NormalizedLwrGlobalConfig;
     runtimeEnvironment: RuntimeEnvironment;
     globalData: GlobalData;
+    hooks: HooksPlugin[];
     services: Services;
     routes: Route<NormalizedLwrRoute>[];
     errorRoutes: Route<NormalizedLwrErrorRoute>[];
 }
 export interface Services {
     moduleProviders: ResolvedServiceEntry<ModuleProvider>[];
+    bundleProviders: ResolvedServiceEntry<BundleProvider>[];
     viewProviders: ResolvedServiceEntry<ViewProvider>[];
     viewTransformers: ResolvedServiceEntry<ViewTransformPlugin>[];
     resourceProviders: ResolvedServiceEntry<ResourceProvider>[];
@@ -165,6 +167,9 @@ export interface BundleConfig {
     external?: Record<string, string>;
     alias?: Record<string, string>;
 }
+export interface BundleConfigOverrides extends BundleConfig {
+    appendExcludes?: boolean;
+}
 export declare type Environment = string;
 export interface EnvironmentConfig {
     default?: Environment;
@@ -191,7 +196,35 @@ export interface InterchangeableModuleRecord {
     };
 }
 export interface HooksPlugin {
-    initConfigs(lwrConfig: NormalizedLwrGlobalConfig, dataConfig: GlobalData, runtimeConfig: RuntimeEnvironment): Promise<void> | void;
+    /**
+     * Programmatically modify application and runtime configurations.
+     *
+     * @remarks
+     * These hooks are invoked both at build time and runtime for Express and Koa(not MRT).
+     *
+     * During server build, config hooks are invoked prior to static site generation
+     * and server bundling.
+     *
+     * For the `createServer`(ie. Express/Koa) runtime, these config hooks are invoked before all other hooks
+     * during server context initialization
+     *
+     * For the `createHandler`(ie. MRT Serverless Express) runtime, these config hooks are NOT invoked.  This runtime does
+     * not support asynchronous execution during initialization.  These hooks MUST be ran during
+     * the server build.
+     *
+     */
+    initConfigs?: (lwrConfig: NormalizedLwrGlobalConfig, dataConfig: GlobalData, runtimeConfig: RuntimeEnvironment) => Promise<void> | void;
+    /**
+     * Load routes on application start up.
+     *
+     * @remarks
+     * These hooks are invoked ONLY at runtime.
+     *
+     * For the `createServer` runtime, these hooks are invoked AFTER config hooks.
+     *
+     * For the `createHandler` runtime, these hooks are invoked during server context initialization.
+     */
+    onStart?: (routes: LwrRoute[]) => void;
 }
 export {};
 //# sourceMappingURL=config.d.ts.map

package/build/index.d.ts

@@ -6,7 +6,7 @@ import type { WatchOptions } from 'chokidar';
 import { EventEmitter } from 'events';
 import fs from 'fs';
 import { Readable } from 'stream';
-import { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord } from './config.js';
+import { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, LwrRoute, LwrErrorRoute, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, Route, BundleConfigOverrides } from './config.js';
 import { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
 export * from './lwr-shim.js';
 export * from './config.js';
@@ -271,15 +271,16 @@ 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>;
+    getModuleBundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams?: RuntimeParams, bundleConfigOverrides?: BundleConfigOverrides): Promise<BundleDefinition>;
+    resolveModuleUri(moduleId: Required<Pick<ModuleId, 'specifier' | 'version'>>, runtimeEnvironment: RuntimeEnvironment, runtimeParams?: RuntimeParams, signature?: string): Promise<string>;
+    getPublicApi(): PublicModuleBundler;
 }
 export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle' | 'resolveModuleUri'>;
 export interface BundleRecord {
@@ -292,6 +293,7 @@ export interface BundleDefinition extends ModuleId {
     config: BundleConfig;
     map?: any;
     bundleRecord: BundleRecord;
+    src?: string;
 }
 export interface ProviderAppConfig {
     modules: ResolverModuleRecord[];
@@ -319,6 +321,7 @@ export interface ProviderContext {
     config: ProviderAppConfig;
     runtimeEnvironment: RuntimeEnvironment;
     watcherFactory?: WatcherFactory;
+    siteMetadata?: SiteMetadata;
 }
 export interface ResourceIdentifier {
     specifier: string;
@@ -334,7 +337,7 @@ export interface AssetUri {
     immutable: boolean;
     entry: string;
 }
-export declare type ResourceType = 'application/javascript' | 'application/json' | 'text/css' | 'lwr-importmap' | 'module';
+export declare type ResourceType = 'application/javascript' | 'application/json' | 'text/css' | 'lwr-importmap' | 'module' | string;
 export interface ResourceDefinition {
     specifier?: string;
     type: ResourceType;
@@ -344,7 +347,7 @@ export interface ResourceDefinition {
     defer?: boolean;
     nonce?: string;
     content?: string;
-    stream?: Readable;
+    stream?: () => Readable;
     isPreload?: boolean;
 }
 export interface AssetMetadata {
@@ -497,10 +500,12 @@ export interface ServerContext {
     viewRegistry: ViewRegistry;
     resourceRegistry: ResourceRegistry;
     assetRegistry: AssetRegistry;
-    appConfig: NormalizedLwrGlobalConfig;
-    runtimeEnvironment: RuntimeEnvironment;
     watcherFactory?: WatcherFactory;
     siteMetadata?: SiteMetadata;
+    appConfig: NormalizedLwrGlobalConfig;
+    runtimeEnvironment: RuntimeEnvironment;
+    routes: Route<LwrRoute>[];
+    errorRoutes: Route<LwrErrorRoute>[];
 }
 export interface Observer<V> {
     next: (value: V) => void;
@@ -578,6 +583,10 @@ export interface LwrStringBuilder {
     original: string;
 }
 export interface SiteMetadata {
+    /**
+     * Get the path that all site metadata is relative to
+     */
+    getSiteRootDir(): string;
     /**
      * Get the current metadata about the pre-built module bundles for the site.
      */
@@ -623,7 +632,7 @@ export interface SiteArtifact {
 export interface SiteBundle extends SiteArtifact {
     version?: Version;
     bundleRecord: {
-        includedModules: string[];
+        includedModules?: string[];
         imports: string[];
     };
 }

package/package.json

@@ -8,15 +8,15 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.9.0-alpha.14",
+    "version": "0.9.0-alpha.16",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
-        "url": "https://github.com/salesforce/lwr.git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr.git",
         "directory": "packages/@lwrjs/types"
     },
     "bugs": {
-        "url": "https://github.com/salesforce/lwr/issues"
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr/issues"
     },
     "main": "build/index.js",
     "files": [
@@ -29,5 +29,9 @@
     "devDependencies": {
         "chokidar": "^3.5.3"
     },
-    "gitHead": "64e0ba617151429da6e09f1a9686628f64183d25"
+    "volta": {
+        "node": "14.19.1",
+        "yarn": "1.22.19"
+    },
+    "gitHead": "03fe3982780e7c63b96ef0733b58529057db61fa"
 }