@lwrjs/types 0.13.0-alpha.0 → 0.13.0-alpha.10

package/build/index.d.ts

@@ -365,6 +365,7 @@ export interface ResourceDefinition {
     specifier?: string;
     type: ResourceType;
     src?: string;
+    entry?: string;
     inline?: boolean;
     async?: boolean;
     defer?: boolean;
@@ -372,6 +373,7 @@ export interface ResourceDefinition {
     content?: string;
     stream?: () => Readable;
     isPreload?: boolean;
+    version?: string;
 }
 export interface AssetMetadata {
     assetReferences?: AssetReference[];
@@ -623,6 +625,16 @@ export interface LwrStringBuilder {
     toString(): string;
     original: string;
 }
+export interface DecisionTree<Artifact extends SiteArtifact> {
+    /**
+     * Insert an artifact into the tree based on a path of decisions
+     */
+    insert(siteArtifactId: string, artifact: Artifact, debug?: boolean, localeFallbacks?: Record<string, string[]>): void;
+    /**
+     * Retrieve an artifact from the tree based on a path of decisions
+     */
+    find(siteArtifactId: string | Partial<AbstractModuleId>, debug?: boolean, localeId?: string): Artifact | undefined;
+}
 export interface SiteMetadata {
     /**
      * Get the path that all site metadata is relative to
@@ -654,6 +666,14 @@ export interface SiteMetadata {
      * @returns
      */
     persistSiteMetadata(): Promise<void>;
+    /**
+     * Get get decision tree to figure out the best site bundle to use.
+     */
+    getSiteBundlesDecisionTree(): DecisionTree<SiteBundle>;
+    /**
+     * Get get decision tree to figure out the best site resource to use.
+     */
+    getSiteResourcesDecisionTree(): DecisionTree<SiteResource>;
 }
 export interface SiteBundles {
     bundles: Record<string, SiteBundle>;

package/build/serviceAPI/serviceAPI.d.ts

@@ -2,15 +2,27 @@ import type { ServerData } from '../index';
 import type { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins';
 import type { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule';
 import type { AppMetadata } from './appMetadata/appMetadata';
-export interface DataServiceAPI {
+export type ServerDataCallbackParams = {
     serverData: ServerData;
+};
+export interface ServerDataCallback {
+    (params: ServerDataCallbackParams): void | null;
 }
-export interface ServiceAPI extends DataServiceAPI {
+interface RegisterServerDataCallback {
+    (hook: ServerDataCallback): void;
+}
+export interface ServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;
+    addServerDataCallback: RegisterServerDataCallback;
     appMetadata: AppMetadata;
 }
+export interface ServerServiceAPI {
+    addLoaderPlugin: NoOp | RegisterLoaderHooks;
+    addServerDataCallback: RegisterServerDataCallback;
+}
 export interface NoOp {
     (): void;
 }
+export {};
 //# sourceMappingURL=serviceAPI.d.ts.map

package/build/views.d.ts

@@ -85,6 +85,7 @@ export interface LinkedViewDefinition {
     viewRecord: RenderedViewRecord;
     immutable: boolean;
     cache?: CacheResponse;
+    nonce?: string;
 }
 export interface ViewRequestQs {
     [key: string]: undefined | string | string[];
@@ -109,6 +110,7 @@ export interface ViewResponse {
     metadata?: {
         viewDefinition?: LinkedViewDefinition;
     };
+    locale?: string;
 }
 export type RouteHandlerViewResponse = ViewDefinitionResponse | ViewResponse;
 export interface ViewDefinitionResponse {
@@ -119,6 +121,7 @@ export interface ViewDefinitionResponse {
     cache?: CacheResponse;
     headers?: Record<string, string>;
     cookie?: 'wip';
+    locale?: string;
 }
 export interface ViewProvider {
     name: string;
@@ -175,11 +178,13 @@ export interface ViewPageContext {
     url: string;
     basePath?: string;
     locale?: string;
+    nonce?: string;
 }
 export type ViewModuleResourceContext = {
     isPreload?: boolean;
     isSSR?: boolean;
     async?: boolean;
+    nonce?: string;
 };
 export interface ViewRegistry {
     addViewProviders(providers: ViewProvider[]): void;
@@ -212,17 +217,28 @@ export interface SsrRequestOptions {
     host?: string;
     requestDepth?: number;
 }
+export type MetaTag = {
+    name?: string;
+    httpEquiv?: string;
+    content?: string;
+};
+export type LinkTag = {
+    href: string;
+    as?: string;
+    rel?: string;
+    fetchpriority?: 'high' | 'low' | 'auto';
+};
 export interface SsrDataResponse {
     props?: {
         [prop: string]: Json;
     };
     markup?: {
-        links?: {
-            href: string;
-            as?: string;
-            rel?: string;
-            fetchpriority?: 'high' | 'low' | 'auto';
+        title?: string;
+        meta?: MetaTag[];
+        scripts?: {
+            body: string;
         }[];
+        links?: LinkTag[];
     };
     cache?: CacheResponse;
 }

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.13.0-alpha.0",
+    "version": "0.13.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,5 +29,5 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "c5fe8db55c74513dbb0937d1b4568109715a13fb"
+    "gitHead": "53e2a825868b4c9b1662419b531c80be13afd779"
 }