@salesforce/lds-runtime-aura 1.229.0-dev1 → 1.229.0-dev10

package/dist/ldsEngineCreator.js

@@ -12,15 +12,16 @@
  *  *******************************************************************************************
  */
 /* proxy-compat-disable */
-import { InMemoryStore, Environment, Luvio, InMemoryStoreQueryEvaluator } from 'force/luvioEngine';
+import { HttpStatusCode, InMemoryStore, Environment, Luvio, InMemoryStoreQueryEvaluator } from 'force/luvioEngine';
 import ldsTrackedFieldsBehaviorGate from '@salesforce/gate/lds.useNewTrackedFieldBehavior';
 import { instrument, configuration, InMemoryRecordRepresentationQueryEvaluator, UiApiNamespace, RecordRepresentationRepresentationType } from 'force/ldsAdaptersUiapi';
 import { withRegistration, register, setDefaultLuvio } from 'force/ldsEngine';
 import { REFRESH_ADAPTER_EVENT, ADAPTER_UNFULFILLED_ERROR, instrument as instrument$2 } from 'force/ldsBindings';
 import { counter, registerCacheStats, perfStart, perfEnd, registerPeriodicLogger, interaction, timer } from 'instrumentation/service';
 import { LRUCache, instrumentAdapter, instrumentLuvio, setupInstrumentation as setupInstrumentation$1, logObjectInfoChanged as logObjectInfoChanged$1, updatePercentileHistogramMetric, incrementCounterMetric, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation } from 'force/ldsInstrumentation';
-import networkAdapter, { instrument as instrument$1, forceRecordTransactionsDisabled, ldsNetworkAdapterInstrument } from 'force/ldsNetwork';
+import auraNetworkAdapter, { instrument as instrument$1, forceRecordTransactionsDisabled, ldsNetworkAdapterInstrument, dispatchAuraAction, defaultActionConfig } from 'force/ldsNetwork';
 import { instrument as instrument$3 } from 'force/adsBridge';
+import { buildJwtNetworkAdapter } from 'force/ldsNetworkFetchWithJwt';
 import { clearStorages } from 'force/ldsStorage';
 
 /**
@@ -31,8 +32,8 @@ import { clearStorages } from 'force/ldsStorage';
  *
  * Below are the R.E.A.D.S. metrics for the Lightning Data Service, defined here[2].
  *
- * [1] https://salesforce.quip.com/NfW9AsbGEaTY
- * [2] https://salesforce.quip.com/1dFvAba1b0eq
+ * [1] Search "[M1] Lightning Data Service Design Spike" in Quip
+ * [2] Search "Lightning Data Service R.E.A.D.S. Metrics" in Quip
  */
 const OBSERVABILITY_NAMESPACE = 'LIGHTNING.lds.service';
 const ADAPTER_INVOCATION_COUNT_METRIC_NAME = 'request';
@@ -597,6 +598,109 @@ function logCRUDLightningInteraction(eventSource, attributes) {
 }
 const instrumentation = new Instrumentation();
 
+class NoComposedAdapterTypeError extends TypeError {
+    constructor(message, resourceRequest) {
+        super(message);
+        this.resourceRequest = resourceRequest;
+    }
+}
+
+function buildComposableNetworkAdapter(composedAdapters) {
+    return (resourceRequest, resourceRequestContext) => {
+        const composedAdapter = composedAdapters.find((adapter) => adapter.shouldHandleRequest(resourceRequest));
+        if (composedAdapter === undefined) {
+            throw new NoComposedAdapterTypeError('There are no network adapters that can process the request.', resourceRequest);
+        }
+        return composedAdapter.adapter(resourceRequest, resourceRequestContext);
+    };
+}
+
+const SALESFORCE_API_BASE_URI_FLAG = 'api.salesforce.com';
+const SFAPController = 'SalesforceApiPlatformController';
+const SFAPJwtMethod = 'getSFAPLightningJwtService';
+/**
+ * We expect jwt info and baseUri to be present in the response.
+ *
+ * @param body
+ */
+function validateResponse(body) {
+    if (!body || !body.jwt || !body.baseUri) {
+        // wrapped the invocation in env conditional
+        // eslint-disable-next-line @salesforce/lds/no-error-in-production
+        throw new Error(`Expected jwt info and baseUri to be present but instead got: ${JSON.stringify(body)}`);
+    }
+}
+/**
+ * Resolves Jwt token for SFAP by calling Aura action
+ * {@link JwtResolver} for platform SFAP
+ */
+const platformSfapJwtResolver = {
+    getJwt() {
+        return new Promise((resolve, reject) => {
+            dispatchAuraAction(`${SFAPController}.${SFAPJwtMethod}`, {}, defaultActionConfig)
+                .then((response) => {
+                const body = response.body;
+                if (process.env.NODE_ENV !== 'production') {
+                    validateResponse(body);
+                }
+                resolve({
+                    jwt: body.jwt,
+                    extraInfo: {
+                        baseUri: body.baseUri,
+                    },
+                });
+            })
+                .catch((error) => {
+                if (error instanceof Error) {
+                    reject(error.message);
+                    return;
+                }
+                // AuraFetchResponse errors
+                const { status } = error;
+                if (status !== HttpStatusCode.ServerError) {
+                    // ConnectInJavaError
+                    reject(error.body.message);
+                    return;
+                }
+                reject(error.body.error);
+            });
+        });
+    },
+};
+/**
+ * This hook is used to modify the resource request before it is sent to the server.
+ * SFAP uses extraInfo assocaiated JwtToken to update the baseUri for the resource request.
+ *
+ * @param resourceRequest
+ * @param jwtToken
+ * @returns resourceRequest with updated baseUri
+ */
+const modifySfapResourceRequest = function (resourceRequest, jwtToken) {
+    const { baseUri } = jwtToken.extraInfo;
+    return {
+        ...resourceRequest,
+        baseUri,
+    };
+};
+const sfapNetworkAdapter = buildJwtNetworkAdapter(platformSfapJwtResolver, modifySfapResourceRequest);
+const composedNetworkAdapter$1 = {
+    shouldHandleRequest(resourceRequest) {
+        return resourceRequest.baseUri === SALESFORCE_API_BASE_URI_FLAG;
+    },
+    adapter: sfapNetworkAdapter,
+};
+
+const composedNetworkAdapter = buildComposableNetworkAdapter([
+    composedNetworkAdapter$1,
+    // The  aura network adapter must be the default.
+    {
+        shouldHandleRequest() {
+            return true;
+        },
+        adapter: auraNetworkAdapter,
+    },
+]);
+
 const OBJECT_INFO_PREFIX = 'UiApi::ObjectInfoRepresentation:';
 /**
  * Watch a Luvio instance for metadata changes.
@@ -652,7 +756,7 @@ function initializeLDS() {
         scheduler: () => { },
     };
     const store = new InMemoryStore(storeOptions);
-    const environment = new Environment(store, networkAdapter);
+    const environment = new Environment(store, composedNetworkAdapter);
     const luvio = new Luvio(environment, {
         instrument: instrumentation.instrumentLuvio.bind(instrumentation),
     });
@@ -669,4 +773,4 @@ function ldsEngineCreator() {
 }
 
 export { ldsEngineCreator as default, initializeLDS };
-// version: 1.229.0-dev1-f69d054a9
+// version: 1.229.0-dev10-bc9ef2513

package/dist/types/__mocks__/@salesforce/lds-network-fetch-with-jwt.d.ts

@@ -0,0 +1 @@
+export declare function buildJwtNetworkAdapter(): void;

package/dist/types/aura-instrumentation/utils/observability.d.ts

@@ -6,8 +6,8 @@
  *
  * Below are the R.E.A.D.S. metrics for the Lightning Data Service, defined here[2].
  *
- * [1] https://salesforce.quip.com/NfW9AsbGEaTY
- * [2] https://salesforce.quip.com/1dFvAba1b0eq
+ * [1] Search "[M1] Lightning Data Service Design Spike" in Quip
+ * [2] Search "Lightning Data Service R.E.A.D.S. Metrics" in Quip
  */
 import type { MetricsKey } from 'instrumentation/service';
 export declare const OBSERVABILITY_NAMESPACE = "LIGHTNING.lds.service";

package/dist/types/network-adapter.d.ts

@@ -0,0 +1,2 @@
+declare const composedNetworkAdapter: import("@luvio/engine").NetworkAdapter;
+export default composedNetworkAdapter;

package/dist/types/network-sfap.d.ts

@@ -0,0 +1,27 @@
+import { type ResourceRequest } from '@luvio/engine';
+import type { JwtResolver } from '@luvio/jwt-manager';
+import type { ModifyResourceRequestHook } from '@salesforce/lds-network-fetch-with-jwt';
+export declare const SFAPController = "SalesforceApiPlatformController";
+export declare const SFAPJwtMethod = "getSFAPLightningJwtService";
+type ExtraInfo = {
+    baseUri: string;
+};
+/**
+ * Resolves Jwt token for SFAP by calling Aura action
+ * {@link JwtResolver} for platform SFAP
+ */
+export declare const platformSfapJwtResolver: JwtResolver<ExtraInfo>;
+/**
+ * This hook is used to modify the resource request before it is sent to the server.
+ * SFAP uses extraInfo assocaiated JwtToken to update the baseUri for the resource request.
+ *
+ * @param resourceRequest
+ * @param jwtToken
+ * @returns resourceRequest with updated baseUri
+ */
+export declare const modifySfapResourceRequest: ModifyResourceRequestHook<unknown, ExtraInfo>;
+declare const composedNetworkAdapter: {
+    shouldHandleRequest(resourceRequest: ResourceRequest): boolean;
+    adapter: import("@luvio/engine").NetworkAdapter;
+};
+export default composedNetworkAdapter;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.229.0-dev1",
+    "version": "1.229.0-dev10",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -34,21 +34,23 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-aura"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-uiapi": "1.229.0-dev1",
-        "@salesforce/lds-ads-bridge": "1.229.0-dev1",
-        "@salesforce/lds-aura-storage": "1.229.0-dev1",
-        "@salesforce/lds-bindings": "1.229.0-dev1",
-        "@salesforce/lds-instrumentation": "1.229.0-dev1",
-        "@salesforce/lds-network-aura": "1.229.0-dev1",
-        "@salesforce/lds-runtime-web": "1.229.0-dev1"
+        "@luvio/network-adapter-composable": "0.146.0-dev5",
+        "@salesforce/lds-adapters-uiapi": "1.229.0-dev10",
+        "@salesforce/lds-ads-bridge": "1.229.0-dev10",
+        "@salesforce/lds-aura-storage": "1.229.0-dev10",
+        "@salesforce/lds-bindings": "1.229.0-dev10",
+        "@salesforce/lds-instrumentation": "1.229.0-dev10",
+        "@salesforce/lds-network-aura": "1.229.0-dev10",
+        "@salesforce/lds-network-fetch-with-jwt": "1.229.0-dev10",
+        "@salesforce/lds-runtime-web": "1.229.0-dev10"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/ldsEngineCreator.js",
             "maxSize": {
                 "none": "32 kB",
-                "min": "12 kB",
-                "compressed": "7 kB"
+                "min": "13 kB",
+                "compressed": "8 kB"
             }
         }
     ]