@lwrjs/types 0.5.11 → 0.6.0-alpha.12

package/build/config.d.ts

@@ -32,6 +32,7 @@ export interface LwrAppBootstrapConfig {
     };
     services?: string[];
     configAsSrc?: boolean;
+    experimentalSSR?: boolean;
 }
 export declare type NormalizedLwrAppBootstrapConfig = Required<LwrAppBootstrapConfig>;
 export interface LwrLockerConfig {
@@ -71,12 +72,15 @@ export interface LwrGlobalConfig {
     globalDataDir?: string;
     globalData?: GlobalData;
     assets?: string | AssetConfig[];
+    assetProviders?: ServiceConfig[];
+    assetTransformers?: ServiceConfig[];
     hooks?: ServiceConfig[];
     environment?: EnvironmentConfig;
     lwc?: LwcConfig;
     moduleProviders?: ServiceConfig[];
     resourceProviders?: ServiceConfig[];
     viewProviders?: ServiceConfig[];
+    viewTransformers?: ServiceConfig[];
     templateEngine?: string;
     routes?: LwrRoute[];
     errorRoutes?: LwrErrorRoute[];
@@ -93,8 +97,10 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
     esmLoader: string;
     moduleProviders: ServiceEntry[];
     viewProviders: ServiceEntry[];
+    viewTransformers: ServiceEntry[];
     resourceProviders: ServiceEntry[];
     assetProviders: ServiceEntry[];
+    assetTransformers: ServiceEntry[];
     lwc: NormalizedLwcConfig;
 }
 export interface StaticSiteGenerator {
@@ -127,6 +133,7 @@ export declare type ServiceConfig = string | ServiceEntry;
 export interface BundleConfig {
     exclude?: string[];
     external?: Record<string, string>;
+    alias?: Record<string, string>;
 }
 export declare type Environment = string;
 export interface EnvironmentConfig {

package/build/index.d.ts

@@ -10,6 +10,7 @@ export * from './metrics.js';
 export * from './serviceAPI/serviceAPI.js';
 export * from './serviceAPI/loaderPlugins/loaderPlugins.js';
 export * from './serviceAPI/handleStaleModule/handleStaleModule.js';
+export * from './serviceAPI/appMetadata/appMetadata.js';
 export declare type Json = undefined | null | boolean | number | string | Json[] | {
     [prop: string]: Json;
 };
@@ -241,7 +242,7 @@ export interface ModuleProvider {
     getModule<T extends AbstractModuleId>(moduleId: T, runtimeParams?: RuntimeParams): Promise<ModuleCompiled | undefined>;
     getModuleEntry<T extends AbstractModuleId>(moduleId: T, runtimeParams?: RuntimeParams): Promise<ModuleEntry | undefined>;
 }
-export declare type LwrService = ModuleProvider | ResourceProvider | ViewProvider | AssetProvider | HooksPlugin;
+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;
 }
@@ -256,8 +257,9 @@ export interface ModuleRegistry {
 }
 export declare type PublicModuleRegistry = Pick<ModuleRegistry, 'getModule' | 'getModuleEntry' | 'resolveModuleUri'>;
 export interface ModuleBundler {
-    getModuleBundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams?: RuntimeParams): Promise<BundleDefinition>;
+    getModuleBundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams?: RuntimeParams, bundleConfigOverrides?: BundleConfig): Promise<BundleDefinition>;
 }
+export declare type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle'>;
 export interface BundleRecord {
     imports?: BaseModuleReference[];
     dynamicImports?: BaseDynamicModuleReference[];
@@ -287,6 +289,7 @@ export interface ProviderContext {
     appObserver: Pick<LwrAppObserver, 'onModuleDefinitionChange' | 'onModuleSourceChange' | 'onAssetSourceChange' | 'onViewSourceChange'>;
     appEmitter: Pick<LwrAppEmitter, 'notifyModuleDefinitionChanged' | 'notifyAssetSourceChanged' | 'notifyModuleSourceChanged' | 'notifyViewSourceChanged'>;
     moduleRegistry: PublicModuleRegistry;
+    moduleBundler: PublicModuleBundler;
     resourceRegistry: PublicResourceRegistry;
     viewRegistry: PublicViewRegistry;
     assetRegistry: PublicAssetRegistry;
@@ -319,19 +322,30 @@ export interface ResourceDefinition {
     stream?: Readable;
     isPreload?: boolean;
 }
+export interface AssetReference {
+    url: string;
+    location: {
+        startOffset: number;
+        endOffset: number;
+    };
+}
+export interface AssetMetadata {
+    assetReferences?: AssetReference[];
+}
 export interface AssetSource {
     entry: string;
     ext: string;
     mime: string | false;
     ownHash: string;
-    stream: (encoding?: BufferEncoding) => Readable;
-    content: (encoding?: BufferEncoding) => string;
+    content: (encoding?: BufferEncoding) => string | Buffer;
     uri?: string;
+    metadata?: AssetMetadata;
 }
 export declare type AssetType = 'asset' | 'content-asset' | 'external' | 'unknown';
 export interface AssetDefinition extends AssetSource {
     uri: string;
     type: AssetType;
+    stream: (encoding?: BufferEncoding) => Readable;
 }
 export declare type ResourceJson = Pick<ResourceDefinition, 'type' | 'src'>;
 export interface ResourceProvider {
@@ -342,6 +356,31 @@ export interface AssetProvider {
     name: string;
     getAsset(fileAssetPath: string): Promise<AssetSource | undefined>;
 }
+declare type TransformPluginContext = Record<string, any>;
+declare type AssetPluginTransformHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginTransformHookReturn>;
+declare type AssetPluginTransformHookReturn = null | undefined | false | string | Buffer | {
+    code: string | Buffer;
+    context?: TransformPluginContext;
+};
+declare type AssetPluginExtractMetaHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginExtractMetaHookReturn>;
+declare type AssetPluginExtractMetaHookReturn = null | undefined | false | {
+    metadata?: AssetMetadata;
+    context?: TransformPluginContext;
+};
+declare type AssetPluginOptimizeHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginOptimizeHookReturn>;
+declare type AssetPluginOptimizeHookReturn = null | undefined | false | string | Buffer | {
+    code: string | Buffer;
+    map?: any;
+    context?: TransformPluginContext;
+};
+export interface AssetTransformHooks {
+    transform: AssetPluginTransformHook;
+    extractMetadata: AssetPluginExtractMetaHook;
+    optimize: AssetPluginOptimizeHook;
+}
+export interface AssetTransformPlugin extends Partial<AssetTransformHooks> {
+    name: string;
+}
 export declare type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
@@ -371,13 +410,21 @@ export interface RenderedView {
     metadata: RenderedViewMetadata;
     options: RenderOptions;
 }
+export interface CustomElementReference {
+    tagName: string;
+    children?: CustomElementReference[];
+    location?: {
+        startOffset: number;
+        endOffset: number;
+    };
+}
 export interface RenderedViewMetadata {
-    customElements: string[];
+    customElements: CustomElementReference[];
     assetReferences: AssetReference[];
 }
 export interface RenderedAssetReference {
     url: string;
-    tagName: string;
+    tagName?: string;
     override?: AssetUri;
 }
 export interface AssetReference extends RenderedAssetReference {
@@ -399,6 +446,8 @@ export interface RenderedViewRecord {
     resources?: ResourceDefinition[];
     assetReferences?: RenderedAssetReference[];
     customElements?: CustomElementRecord[];
+    endpoints?: Endpoints;
+    importMetadata?: ImportMetadata;
     bootstrapModule?: {
         specifier: Specifier;
         flatGraph: FlattenedModuleGraphs;
@@ -448,6 +497,35 @@ export interface ViewProvider {
     initialize(): Promise<void>;
     getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
 }
+export interface ViewTranformPluginContext {
+    view: View;
+    viewParams: ViewParams;
+    runtimeEnvironment: RuntimeEnvironment;
+    runtimeParams: RuntimeParams;
+    renderOptions: Required<RenderOptions>;
+    contentIds: {
+        lwrResourcesId: string;
+    };
+    importer?: string;
+}
+declare type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTranformPluginContext, viewMetadata: RenderedViewMetadata, context?: TransformPluginContext) => Promise<ViewPluginLinkHookReturn>;
+declare type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
+    builder?: LwrStringBuilder;
+    context?: TransformPluginContext;
+};
+declare type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource, context?: TransformPluginContext) => Promise<ViewPluginOptimizeHookReturn>;
+declare type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
+    code: string;
+    map?: any;
+    context?: TransformPluginContext;
+};
+export interface ViewTransformHooks {
+    link: ViewPluginLinkHook;
+    optimize: ViewPluginOptimizeHook;
+}
+export interface ViewTransformPlugin extends Partial<ViewTransformHooks> {
+    name: string;
+}
 export declare type ViewParams = Record<string, Json>;
 export interface ViewInfo {
     id: string;
@@ -485,7 +563,7 @@ export declare type PublicResourceRegistry = Pick<ResourceRegistry, 'getResource
 export interface AssetRegistry {
     name: string;
     addAssetProviders(provider: AssetProvider[]): void;
-    getAsset<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<AssetSource>;
+    getAsset<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<AssetDefinition>;
     resolveAssetUri<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<AssetUri>;
     getPublicApi(): PublicAssetRegistry;
 }
@@ -626,4 +704,32 @@ export interface FlattenedModuleGraphs {
 export declare type ImportMapImports = {
     [key: string]: string;
 };
+export interface LwrBuilderOverwriteOptions {
+    storeName?: boolean;
+    contentOnly?: boolean;
+}
+export interface LwrStringBuilder {
+    append(content: string): LwrStringBuilder;
+    appendLeft(index: number, content: string): LwrStringBuilder;
+    appendRight(index: number, content: string): LwrStringBuilder;
+    clone(): LwrStringBuilder;
+    move(start: number, end: number, index: number): LwrStringBuilder;
+    overwrite(start: number, end: number, content: string, options?: boolean | LwrBuilderOverwriteOptions): LwrStringBuilder;
+    prepend(content: string): LwrStringBuilder;
+    prependLeft(index: number, content: string): LwrStringBuilder;
+    prependRight(index: number, content: string): LwrStringBuilder;
+    remove(start: number, end: number): LwrStringBuilder;
+    slice(start: number, end: number): string;
+    snip(start: number, end: number): LwrStringBuilder;
+    trim(charType?: string): LwrStringBuilder;
+    trimStart(charType?: string): LwrStringBuilder;
+    trimEnd(charType?: string): LwrStringBuilder;
+    trimLines(): LwrStringBuilder;
+    lastChar(): string;
+    lastLine(): string;
+    isEmpty(): boolean;
+    length(): number;
+    toString(): string;
+    original: string;
+}
 //# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -5,4 +5,5 @@ export * from './metrics.js';
 export * from './serviceAPI/serviceAPI.js';
 export * from './serviceAPI/loaderPlugins/loaderPlugins.js';
 export * from './serviceAPI/handleStaleModule/handleStaleModule.js';
+export * from './serviceAPI/appMetadata/appMetadata.js';
 //# sourceMappingURL=index.js.map

package/build/serviceAPI/appMetadata/appMetadata.d.ts

@@ -0,0 +1,6 @@
+export declare type AppMetadata = {
+    bootstrapModule: string;
+    rootComponent?: string;
+    rootComponents?: string[];
+};
+//# sourceMappingURL=appMetadata.d.ts.map

package/build/serviceAPI/appMetadata/appMetadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=appMetadata.js.map

package/build/serviceAPI/serviceAPI.d.ts

@@ -1,8 +1,10 @@
 import { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins';
 import { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule';
+import { AppMetadata } from './appMetadata/appMetadata';
 export interface ServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;
+    appMetadata: AppMetadata;
 }
 export interface NoOp {
     (): void;

package/package.json

@@ -8,8 +8,8 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.5.11",
-    "homepage": "https://lwr.dev/",
+    "version": "0.6.0-alpha.12",
+    "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
         "url": "https://github.com/salesforce/lwr.git",
@@ -27,5 +27,5 @@
     "engines": {
         "node": ">=14.15.4 <17"
     },
-    "gitHead": "2ee810c0a4f1f36d1e0f8378a1fe00c19b4c5bc1"
+    "gitHead": "876b56ca4f98f3299303f2193c0dec8f46a69b84"
 }